Skip to content

Don't always re-train when creating the documentation #797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
johannes-spies wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Don't always re-train when creating the documentation #797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1e7783f
Add command-line switch to disable training
johannes-spies Oct 8, 2025
9fbaffe
Document usage
johannes-spies Oct 8, 2025
0c2503e
Merge branch 'main' into retrain-on-demand
johannes-spies Oct 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@ machine as described above. Then, build the documentation with
.. code-block:: bash

tox -e docs
# Optional: Prepend TRAIN=0 to skip training models when generating documentation
TRAIN=0 tox -e docs

You can then visualize the local documentation with your favorite browser using the
following command (or open the :file:`docs/build/html/index.html` file manually).
Expand Down
9 changes: 5 additions & 4 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ commands =

[testenv:docs]
description = builds the documentation with sphinx
passenv = TRAIN
deps =
-r docs/requirements.txt
cmake
Expand All @@ -165,10 +166,10 @@ extras = # these models are used in the documentation
commands =
python -m pip install --no-build-isolation sphericart torch-spex>=0.1,<0.2 wigners
# Run example and usage scripts.
bash -c "set -e && cd {toxinidir}/examples/basic_usage && bash usage.sh"
bash -c "set -e && cd {toxinidir}/examples/ase && bash train.sh"
bash -c "set -e && cd {toxinidir}/examples/llpr && bash train.sh"
bash -c "set -e && cd {toxinidir}/examples/zbl && bash train.sh"
bash -c 'if [ "{env:TRAIN:1}" != "0" ]; then set -e && cd {toxinidir}/examples/basic_usage && bash usage.sh; fi'
bash -c 'if [ "{env:TRAIN:1}" != "0" ]; then set -e && cd {toxinidir}/examples/ase && bash train.sh; fi'
bash -c 'if [ "{env:TRAIN:1}" != "0" ]; then set -e && cd {toxinidir}/examples/llpr && bash train.sh; fi'
bash -c 'if [ "{env:TRAIN:1}" != "0" ]; then set -e && cd {toxinidir}/examples/zbl && bash train.sh; fi'
sphinx-build \
{posargs:-E} \
--builder html \
Expand Down