README.md

---
configs:
- config_name: '201301'
  data_files:
  - split: train
    path: data/201301/train-*
- config_name: '201302'
  data_files:
  - split: train
    path: data/201302/train-*
- config_name: '201303'
  data_files:
  - split: train
    path: data/201303/train-*
- config_name: '201304'
  data_files:
  - split: train
    path: data/201304/train-*
- config_name: '201305'
  data_files:
  - split: train
    path: data/201305/train-*
- config_name: '201306'
  data_files:
  - split: train
    path: data/201306/train-*
- config_name: '201307'
  data_files:
  - split: train
    path: data/201307/train-*
- config_name: '201308'
  data_files:
  - split: train
    path: data/201308/train-*
- config_name: '201309'
  data_files:
  - split: train
    path: data/201309/train-*
- config_name: '201310'
  data_files:
  - split: train
    path: data/201310/train-*
- config_name: '201312'
  data_files:
  - split: train
    path: data/201312/train-*
- config_name: '201403'
  data_files:
  - split: train
    path: data/201403/train-*
- config_name: '201405'
  data_files:
  - split: train
    path: data/201405/train-*
- config_name: '201410'
  data_files:
  - split: train
    path: data/201410/train-*
- config_name: '201412'
  data_files:
  - split: train
    path: data/201412/train-*
- config_name: '201501'
  data_files:
  - split: train
    path: data/201501/train-*
- config_name: '201504'
  data_files:
  - split: train
    path: data/201504/train-*
- config_name: '201505'
  data_files:
  - split: train
    path: data/201505/train-*
- config_name: '201603'
  data_files:
  - split: train
    path: data/201603/train-*
- config_name: '201604'
  data_files:
  - split: train
    path: data/201604/train-*
- config_name: '201605'
  data_files:
  - split: train
    path: data/201605/train-*
- config_name: '201606'
  data_files:
  - split: train
    path: data/201606/train-*
- config_name: '201607'
  data_files:
  - split: train
    path: data/201607/train-*
- config_name: '201608'
  data_files:
  - split: train
    path: data/201608/train-*
- config_name: '201609'
  data_files:
  - split: train
    path: data/201609/train-*
- config_name: '201610'
  data_files:
  - split: train
    path: data/201610/train-*
- config_name: '201611'
  data_files:
  - split: train
    path: data/201611/train-*
- config_name: '201612'
  data_files:
  - split: train
    path: data/201612/train-*
- config_name: '201701'
  data_files:
  - split: train
    path: data/201701/train-*
- config_name: '201702'
  data_files:
  - split: train
    path: data/201702/train-*
- config_name: '201703'
  data_files:
  - split: train
    path: data/201703/train-*
- config_name: '201704'
  data_files:
  - split: train
    path: data/201704/train-*
- config_name: '201705'
  data_files:
  - split: train
    path: data/201705/train-*
- config_name: '201706'
  data_files:
  - split: train
    path: data/201706/train-*
- config_name: '201707'
  data_files:
  - split: train
    path: data/201707/train-*
- config_name: '201708'
  data_files:
  - split: train
    path: data/201708/train-*
- config_name: '201709'
  data_files:
  - split: train
    path: data/201709/train-*
- config_name: '201710'
  data_files:
  - split: train
    path: data/201710/train-*
- config_name: '201711'
  data_files:
  - split: train
    path: data/201711/train-*
- config_name: '201712'
  data_files:
  - split: train
    path: data/201712/train-*
- config_name: '201801'
  data_files:
  - split: train
    path: data/201801/train-*
- config_name: '201802'
  data_files:
  - split: train
    path: data/201802/train-*
- config_name: '201803'
  data_files:
  - split: train
    path: data/201803/train-*
- config_name: '201804'
  data_files:
  - split: train
    path: data/201804/train-*
- config_name: '201805'
  data_files:
  - split: train
    path: data/201805/train-*
- config_name: '201806'
  data_files:
  - split: train
    path: data/201806/train-*
- config_name: '201807'
  data_files:
  - split: train
    path: data/201807/train-*
- config_name: '201808'
  data_files:
  - split: train
    path: data/201808/train-*
- config_name: '201809'
  data_files:
  - split: train
    path: data/201809/train-*
- config_name: '201810'
  data_files:
  - split: train
    path: data/201810/train-*
- config_name: '201811'
  data_files:
  - split: train
    path: data/201811/train-*
- config_name: '201812'
  data_files:
  - split: train
    path: data/201812/train-*
- config_name: '201901'
  data_files:
  - split: train
    path: data/201901/train-*
- config_name: '201902'
  data_files:
  - split: train
    path: data/201902/train-*
- config_name: '201903'
  data_files:
  - split: train
    path: data/201903/train-*
- config_name: '201904'
  data_files:
  - split: train
    path: data/201904/train-*
- config_name: '201905'
  data_files:
  - split: train
    path: data/201905/train-*
- config_name: '201906'
  data_files:
  - split: train
    path: data/201906/train-*
- config_name: '201907'
  data_files:
  - split: train
    path: data/201907/train-*
- config_name: '201908'
  data_files:
  - split: train
    path: data/201908/train-*
- config_name: '201909'
  data_files:
  - split: train
    path: data/201909/train-*
- config_name: '201910'
  data_files:
  - split: train
    path: data/201910/train-*
- config_name: '201911'
  data_files:
  - split: train
    path: data/201911/train-*
- config_name: '201912'
  data_files:
  - split: train
    path: data/201912/train-*
- config_name: '202001'
  data_files:
  - split: train
    path: data/202001/train-*
- config_name: '202002'
  data_files:
  - split: train
    path: data/202002/train-*
- config_name: '202003'
  data_files:
  - split: train
    path: data/202003/train-*
- config_name: '202004'
  data_files:
  - split: train
    path: data/202004/train-*
- config_name: '202005'
  data_files:
  - split: train
    path: data/202005/train-*
- config_name: '202006'
  data_files:
  - split: train
    path: data/202006/train-*
- config_name: '202007'
  data_files:
  - split: train
    path: data/202007/train-*
- config_name: '202008'
  data_files:
  - split: train
    path: data/202008/train-*
- config_name: '202009'
  data_files:
  - split: train
    path: data/202009/train-*
- config_name: '202011'
  data_files:
  - split: train
    path: data/202011/train-*
- config_name: '202012'
  data_files:
  - split: train
    path: data/202012/train-*
- config_name: '202101'
  data_files:
  - split: train
    path: data/202101/train-*
- config_name: '202102'
  data_files:
  - split: train
    path: data/202102/train-*
- config_name: '202103'
  data_files:
  - split: train
    path: data/202103/train-*
- config_name: '202104'
  data_files:
  - split: train
    path: data/202104/train-*
- config_name: '202105'
  data_files:
  - split: train
    path: data/202105/train-*
- config_name: '202106'
  data_files:
  - split: train
    path: data/202106/train-*
- config_name: '202108'
  data_files:
  - split: train
    path: data/202108/train-*
- config_name: '202109'
  data_files:
  - split: train
    path: data/202109/train-*
- config_name: '202110'
  data_files:
  - split: train
    path: data/202110/train-*
- config_name: '202111'
  data_files:
  - split: train
    path: data/202111/train-*
- config_name: '202112'
  data_files:
  - split: train
    path: data/202112/train-*
- config_name: '202201'
  data_files:
  - split: train
    path: data/202201/train-*
- config_name: '202202'
  data_files:
  - split: train
    path: data/202202/train-*
- config_name: '202203'
  data_files:
  - split: train
    path: data/202203/train-*
- config_name: '202204'
  data_files:
  - split: train
    path: data/202204/train-*
- config_name: '202206'
  data_files:
  - split: train
    path: data/202206/train-*
- config_name: '202208'
  data_files:
  - split: train
    path: data/202208/train-*
- config_name: '202209'
  data_files:
  - split: train
    path: data/202209/train-*
- config_name: '202210'
  data_files:
  - split: train
    path: data/202210/train-*
- config_name: '202211'
  data_files:
  - split: train
    path: data/202211/train-*
- config_name: '202212'
  data_files:
  - split: train
    path: data/202212/train-*
- config_name: '202301'
  data_files:
  - split: train
    path: data/202301/train-*
- config_name: '202302'
  data_files:
  - split: train
    path: data/202302/train-*
- config_name: '202303'
  data_files:
  - split: train
    path: data/202303/train-*
- config_name: '202304'
  data_files:
  - split: train
    path: data/202304/train-*
- config_name: '202305'
  data_files:
  - split: train
    path: data/202305/train-*
- config_name: '202306'
  data_files:
  - split: train
    path: data/202306/train-*
- config_name: '202307'
  data_files:
  - split: train
    path: data/202307/train-*
- config_name: '202308'
  data_files:
  - split: train
    path: data/202308/train-*
- config_name: '202309'
  data_files:
  - split: train
    path: data/202309/train-*
- config_name: '202310'
  data_files:
  - split: train
    path: data/202310/train-*
- config_name: '202311'
  data_files:
  - split: train
    path: data/202311/train-*
- config_name: '202312'
  data_files:
  - split: train
    path: data/202312/train-*
- config_name: default
  data_files:
  - split: train
    path: data/201301/train-*
---

# Dataset Card for Lichess.org UCI Dataset

## Description
<!-- 
- **Homepage:** [Lichess.org Database](https://database.lichess.org/)
- **Repository:** [GitHub Repository](https://github.com/austindavis/lichess-uci)
- **Paper:** N/A
- **Leaderboard:** N/A -->

The Lichess.org database has been converted to UCI format and uploaded here. 
This dataset groups games according to the year and month (yyyymm format) the games took place.

### Dataset Structure

Each record in the dataset has the following structure:

```json
{
  "Site": "abcd1234",
  "Event": "Rated Blitz game",
  "White": "player1",
  "Black": "player2",
  "Result": "1-0",
  "UTCDate": "2023-05-21",
  "UTCTime": "13:45:00",
  "WhiteElo": 1500,
  "BlackElo": 1400,
  "WhiteRatingDiff": 10,
  "BlackRatingDiff": -10,
  "ECO": "C50",
  "Opening": "Italian Game",
  "TimeControl": "300+0",
  "Termination": "Normal",
  "Transcript": "e2e4 e7e5 g1f3 b8c6 ... d7d8Q"
}
```
### Field descriptions
- `Site`: string, unique identifier for the game. Replays can be viewed by navigating to `https://lichess.org/<site>`
- `Event`: string, type of event.
- `White`: string, white player.
- `Black`: string, black player.
- `Result`: string, game result.
- `UTCDate`: date32, date of the game.
- `UTCTime`: time64[us], time of the game.
- `WhiteElo`: int64, ELO rating of the white player.
- `BlackElo`: int64, ELO rating of the black player.
- `WhiteRatingDiff`: float64, rating change for the white player.
- `BlackRatingDiff`: float64, rating change for the black player.
- `ECO`: string, Encyclopaedia of Chess Openings (ECO) code of the opening. See [https://www.365chess.com/eco.php](https://www.365chess.com/eco.php)
- `Opening`: string, name of the opening.
- `TimeControl`: string, time control format.
- `Termination`: string, reason for game termination.
- `Transcript`: string, sequence of moves in UCI format. Note: Promotions are capitalized.


### Python Chess Gotchas
For those new to the datasets here's a few things to watch out for:
- The python Chess library uses lowercase letters to indicate pawn promotion, but this dataset uses upper-case letters instead (as a natural consequence of using `pgn-extract`, this also disambiguates bishop promotions 'b' from the b-file (column)). You may want to use `str.lower()` whenever processing transcripts with the Chess library.
- Empty transcripts are using '0-1' by `pgn-extract`. (example: lichess.org/AvQ6x3da)

### Human versus Bot Players

The source data comes from games played on Lichess.org, an online platform where users from around the world play chess.
This database does not distinguish between human-and bot-played games. 
However, it's reasonable to assume games played before April 2018 were overwhelmingly played by human players since Lichess.org 
released its [bot api](https://github.com/lichess-org/api) on April 1st, 2018. (no joke!)

### Citation Information

If you use this dataset, please cite it as follows:

```
@misc{lichess_uci,
  author = {Davis, Austin},
  title = {Lichess.org Open Database in UCI format},
  year = {2024},
  howpublished = {\url{https://huggingface.co/datasets/austindavis/lichess-uci}},
}
```