ssingh22 commited on
Commit
1f96f00
·
verified ·
1 Parent(s): 4c63fcf

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +36 -2
README.md CHANGED
@@ -52,6 +52,40 @@ configs:
52
  - split: train
53
  path: tactics/train-*
54
  ---
55
- # Dataset Card for "chess-evaluations"
56
 
57
- [More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
52
  - split: train
53
  path: tactics/train-*
54
  ---
55
+ # Chess Evaluations Dataset
56
 
57
+ This dataset contains chess positions represented in FEN (Forsyth-Edwards Notation) along with their evaluations and next moves for tactical evals. The dataset is divided into three configurations:
58
+
59
+ 1. **tactics**: Includes chess positions, their evaluations, and the best move in the position.
60
+ 2. **randoms**: Contains random chess positions and their evaluations.
61
+ 3. **chess_data**: General chess positions with evaluations.
62
+
63
+ This is an in progress dataset which contains millions of positions with stockfish 11 (depth 22) evaluations. Please help contribute evaluations of the positions to the repo, the original owner of the dataset is [r2dev2](https://github.com/r2dev2/ChessData).
64
+ > ❗❗❗ Updates to the original dataset will be on the [version hosted on kaggle](https://www.kaggle.com/ronakbadhe/chess-evaluations).
65
+
66
+ ## Dataset Structure
67
+
68
+ Each configuration can be loaded separately:
69
+
70
+ - **tactics**: Columns - `FEN`, `Evaluation`, `Move`
71
+ - **randoms**: Columns - `FEN`, `Evaluation`
72
+ - **chess_data**: Columns - `FEN`, `Evaluation`
73
+
74
+ ## Usage
75
+
76
+ You can load each configuration using the `datasets` library:
77
+
78
+ ```python
79
+ from datasets import load_dataset
80
+
81
+ # Load the tactics dataset
82
+ tactics_dataset = load_dataset("someshsingh22/chess-evaluations", "tactics")
83
+
84
+ # Load the randoms dataset
85
+ randoms_dataset = load_dataset("someshsingh22/chess-evaluations", "randoms")
86
+ ```
87
+
88
+ ## Contributing
89
+ To get started download a pre-built executable from the releases of [chess contributor](https://github.com/r2dev2bb8/ChessDataContributor/releases) and run it.
90
+
91
+ The evaluation should go in eval folder under same name