Skip to content

Commit 04a3d4b

Browse files
committed
Update readme
1 parent 5204005 commit 04a3d4b

File tree

2 files changed

+36
-1
lines changed

2 files changed

+36
-1
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,41 @@
11
# LiveChess2FEN
22

3-
Automatic digitization of live chess games to FEN notation by means of computer vision.
3+
LiveChess2FEN is a fully functional framework that automatically digitizes
4+
the configuration of a chessboard. It is optimized for execution on a
5+
Nvidia Jetson Nano, following the edge computing paradigm.
6+
7+
![](docs/complete_method.png)
8+
9+
## Setup
10+
11+
1. Install Python 3.5 or later and the following dependencies:
12+
- NumPy
13+
- OpenCV4
14+
- Matplotlib
15+
- scikit-learn
16+
- pillow
17+
- pyclipper
18+
- tqdm
19+
20+
2. Depending on the inference engine install the following dependencies:
21+
- Keras with tensorflow backend
22+
- Onnxruntime
23+
- TensorRT
24+
25+
3. Create a `selected_models` folder in the project root.
26+
4. Download the prediction models from the
27+
[releases](https://github.com/davidmallasen/LiveChess2FEN/releases)
28+
and save them to the `selected_models` folder.
29+
5. Create a `predictions/input_board` folder and a `predictions/pieces`
30+
folder in the project root.
31+
6. Download the contents of `TestImages.zip->FullDetection` from the
32+
[releases](https://github.com/davidmallasen/LiveChess2FEN/releases) into
33+
the `predictions/input_board` folder. You should have 5 test images and a
34+
boards.fen file.
35+
7. Edit `lc2fen_predict.py` and set the `ACTIVATE_*`, `MODEL_PATH_*`,
36+
`IMG_SIZE_*` and `PRE_INPUT_*` constants.
37+
8. Run the `lc2fen_predict.py` script.
38+
439

540
## License
641

docs/complete_method.png

1.44 MB
Loading

0 commit comments

Comments
 (0)