chesscog.report package

This module contains scripts that convert various data files stored in the results:// folder in a format to be used in the report. Thus, some scripts might generate LaTeX snippets.

Submodules

chesscog.report.prepare_classifier_results module

Script to prepare the results of a (occupancy or piece) classifier for LaTeX.

$ python -m chesscog.report.prepare_classifier_results --help
usage: prepare_classifier_results.py [-h]
                                     [--classifier {occupancy_classifier,piece_classifier}]

Prepare results for LaTeX

optional arguments:
  -h, --help            show this help message and exit
  --classifier {occupancy_classifier,piece_classifier}

chesscog.report.prepare_confusion_matrix module

Script to prepare the inference results as a confusion matrix for use in a LaTeX table.

$ python -m chesscog.report.prepare_confusion_matrix --help
usage: prepare_confusion_matrix.py [-h] [--results RESULTS]
                                   [--dataset DATASET]

Prepare confusion matrix for LaTeX

optional arguments:
  -h, --help         show this help message and exit
  --results RESULTS  parent results folder
  --dataset DATASET  the dataset to evaluate

chesscog.report.prepare_error_distribution module

Script to output some information about the distribution of errors in the recognition.

$ python -m chesscog.report.prepare_error_distribution --help
usage: prepare_error_distribution.py [-h] [--results RESULTS]
                                     [--dataset DATASET]

Prepare distribution of mistakes per board for LaTeX

optional arguments:
  -h, --help         show this help message and exit
  --results RESULTS  parent results folder
  --dataset DATASET  the dataset to evaluate

chesscog.report.prepare_recognition_results module

Main script to output accuracy statistics and other benchmarks of the inference pipeline.

$ python -m chesscog.report.prepare_recognition_results --help
usage: prepare_recognition_results.py [-h] [--results RESULTS]
                                      [--dataset DATASET]

Prepare results for LaTeX

optional arguments:
  -h, --help         show this help message and exit
  --results RESULTS  parent results folder
  --dataset DATASET  the dataset to evaluate