Skip to content
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.

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

Minor tutorial fixes #683

Merged
merged 7 commits into from
Jan 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ spktrain experiment=qm9_atomwise run.data_dir=<path> model/representation=painn
```

For more details on config groups, have a look at the
[Hydra docs](https://hydra.cc/docs/next/tutorials/basic/your_first_app/config_groups).
[Hydra docs](https://hydra.cc/docs/tutorials/basic/your_first_app/config_groups/).


### Example 2: Potential energy surfaces
Expand Down
6 changes: 3 additions & 3 deletions docs/getstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ All values of the config can be changed from the command line, including the dir
By default, the model is stored in a directory with a unique run id hash as a subdirectory of ``spk_workdir/runs``.
This can be changed as follows::

$ spktrain experiment=qm9 run.data_dir=/my/data/dir run.path=~/all_my_runs run.id=this_run
$ spktrain experiment=qm9_atomwise run.data_dir=/my/data/dir run.path=~/all_my_runs run.id=this_run

If you call ``spktrain experiment=qm9 --help``, you can see the full config with all the parameters
If you call ``spktrain experiment=qm9_atomwise --help``, you can see the full config with all the parameters
that can be changed.
Nested parameters can be changed as follows::

Expand Down Expand Up @@ -114,7 +114,7 @@ If you would want to additionally change some value of this group, you could use
$ spktrain experiment=qm9_atomwise data_dir=<path> model/representation=painn model.representation.n_interactions=5

For more details on config groups, have a look at the
`Hydra docs <https://hydra.cc/docs/next/tutorials/basic/your_first_app/config_groups>`_.
`Hydra docs <https://hydra.cc/docs/tutorials/basic/your_first_app/config_groups/>`_.


Example 2: Potential energy surfaces
Expand Down
Loading