PySymGym¶
Documentation navigation map: start here to find your way around the project.
README.md is the entrypoint for navigating the project. This page is the
map: it lists every documentation page, grouped by area, with a brief
description. The map is generated from the :description: and
:group: metadata at the top of each page (and the description is rendered
as the page’s opening line). To register a page, give it that metadata and add
it to the hidden toctree below; the docs build fails without valid metadata or
with a stale README link. The documentation skill says what to update when
code changes.
The published documentation is hosted at pysymgym.github.io/PySymGym.
Documentation map¶
Group |
Page |
Description |
|---|---|---|
Overview |
High-level map of the system and where to find things. |
|
Guides |
Expand the training dataset and maintain it with helper tools. |
|
Guides |
Integrate a new symbolic engine and convert a trained model to ONNX. |
|
Guides |
Compare the trained AI selector with the best selector of V#. |
|
Guides |
Build the engines, run training and tuning, improve the dataset, and execute with a trained model. |
|
Development |
Contribution model, tests, style checks, docs build, and CI. |
|
Development |
Install the toolchain, configure the Python environment, and keep submodule checkouts healthy on a fresh machine. |
|
Development |
The local-first test system: taxonomy, commands, fixtures, and coverage. |
|
Reference |
API reference for the shared, dependency-light helper modules. |