Upload ChessBot Chess model

README.md

@@ -1,16 +1,73 @@
 ---
 license: mit
-pipeline_tag: tabular-classification
 tags:
-- board-games
 - chess
-- model_hub_mixin
-- pytorch_model_hub_mixin
 - reinforcement-learning
-- transformer
+- game-ai
+- pytorch
+library_name: transformers
 ---
 
-This model has been pushed to the Hub using the [PytorchModelHubMixin](https://huggingface.co/docs/huggingface_hub/package_reference/mixins#huggingface_hub.PyTorchModelHubMixin) integration:
-- Code: https://github.com/user/chessbot
-- Paper: [More Information Needed]
-- Docs: [More Information Needed]
+# ChessBot Chess Model
+
+This is a ChessBot model for chess move prediction and position evaluation.
+
+## Model Description
+
+The ChessBot model is a transformer-based architecture designed for chess gameplay. It can:
+- Predict the next best move given a chess position (FEN)
+- Evaluate chess positions
+- Generate move probabilities
+
+## Usage
+
+```python
+import torch
+from huggingface_hub import snapshot_download
+
+# Download the model files
+model_path = snapshot_download(repo_id="Maxlegrec/ChessBot")
+
+# Add to path and import
+import sys
+sys.path.append(model_path)
+from modeling_chessbot import ChessBotModel, ChessBotConfig
+
+# Load the model
+config = ChessBotConfig()
+model = ChessBotModel.from_pretrained(model_path)
+
+# Example usage
+fen = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1"
+device = "cuda" if torch.cuda.is_available() else "cpu"
+model = model.to(device)
+
+# Get the best move
+move = model.get_move_from_fen_no_thinking(fen, T=0.1, device=device)
+print(f"Predicted move: {move}")
+```
+
+## Requirements
+
+- torch>=2.0.0
+- transformers>=4.30.0
+- python-chess>=1.10.0
+- numpy>=1.21.0
+
+## Model Architecture
+
+- **Transformer layers**: 10
+- **Hidden size**: 512
+- **Feed-forward size**: 736
+- **Attention heads**: 8
+- **Vocabulary size**: 1929 (chess moves)
+
+## Training Data
+
+This model was trained on chess game data to learn optimal move selection and position evaluation.
+
+## Limitations
+
+- The model works best with standard chess positions
+- Performance may vary with unusual or rare positions
+- Requires GPU for optimal inference speed

config.json

@@ -2,7 +2,9 @@
   "d_ff": 736,
   "d_model": 512,
   "max_position_embeddings": 64,
+  "model_type": "chessbot",
   "num_heads": 8,
   "num_layers": 10,
+  "transformers_version": "4.53.1",
   "vocab_size": 1929
-}
+}

usage_example.py

@@ -10,16 +10,12 @@ This model can be used without installing any external packages except:
 
 import torch
 import sys
-import os
-
-# Get the directory of this script (the model directory)
-model_dir = os.path.dirname(os.path.abspath(__file__))
-sys.path.append(model_dir)  # Add the model directory to path
+sys.path.append("./")  # Add the model directory to path
 from modeling_chessbot import ChessBotModel, ChessBotConfig
 
 # Load the model
 config = ChessBotConfig()
-model = ChessBotModel.from_pretrained(model_dir)
+model = ChessBotModel.from_pretrained("./")
 
 # Example usage
 fen = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1"