Skip to content

Commit f3e9789

Browse files
authored
Fix docs toc (#1315)
* small toc fix * fix code to code-cell
1 parent ebda737 commit f3e9789

14 files changed

Lines changed: 30 additions & 28 deletions

File tree

docs/_toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ parts:
2323
- file: core/common_tasks/fine_tuning
2424
- file: core/common_tasks/workflows
2525
- file: core/uma_faq
26-
- file: core/uma_tutorials/summary
26+
- file: uma_tutorials/summary
2727
sections:
28-
- file: core/uma_tutorials/uma_tutorial
28+
- file: uma_tutorials/uma_tutorial
2929
- file: core/uma_examples/summary
3030
sections:
3131
- file: core/uma_examples/uma_tutorial

docs/catalysts/examples_tutorials/OCP-introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The first step is getting a checkpoint for the model we want to use. UMA is curr
6262
6363
6464
1. Install the necessary packages using pip, uv etc
65-
```{code}
65+
```{code-cell} ipython3
6666
:tags: [skip-execution]
6767
6868
! pip install fairchem-core fairchem-data-oc fairchem-applications-cattsunami
@@ -74,7 +74,7 @@ The first step is getting a checkpoint for the model we want to use. UMA is curr
7474
* Create a Huggingface token at https://huggingface.co/settings/tokens/ with the permission "Permissions: Read access to contents of all public gated repos you can access"
7575
* Add the token as an environment variable using `huggingface-cli login` or by setting the HF_TOKEN environment variable.
7676
77-
```{code}
77+
```{code-cell} ipython3
7878
:tags: [skip-execution]
7979
8080
# Login using the huggingface-cli utility

docs/catalysts/examples_tutorials/adsorbml_walkthrough.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The latest UMA models are now total-energy models, and the results for the adsor
2222
2323
2424
1. Install the necessary packages using pip, uv etc
25-
```{code}
25+
```{code-cell} ipython3
2626
:tags: [skip-execution]
2727
2828
! pip install fairchem-core fairchem-data-oc fairchem-applications-cattsunami
@@ -34,7 +34,7 @@ The latest UMA models are now total-energy models, and the results for the adsor
3434
* Create a Huggingface token at https://huggingface.co/settings/tokens/ with the permission "Permissions: Read access to contents of all public gated repos you can access"
3535
* Add the token as an environment variable using `huggingface-cli login` or by setting the HF_TOKEN environment variable.
3636
37-
```{code}
37+
```{code-cell} ipython3
3838
:tags: [skip-execution]
3939
4040
# Login using the huggingface-cli utility

docs/catalysts/examples_tutorials/adsorption_energies/adsorption_energies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ One of the most common tasks in computational catalysis is calculating the bindi
2222
2323
2424
1. Install the necessary packages using pip, uv etc
25-
```{code}
25+
```{code-cell} ipython3
2626
:tags: [skip-execution]
2727
2828
! pip install fairchem-core fairchem-data-oc fairchem-applications-cattsunami
@@ -34,7 +34,7 @@ One of the most common tasks in computational catalysis is calculating the bindi
3434
* Create a Huggingface token at https://huggingface.co/settings/tokens/ with the permission "Permissions: Read access to contents of all public gated repos you can access"
3535
* Add the token as an environment variable using `huggingface-cli login` or by setting the HF_TOKEN environment variable.
3636
37-
```{code}
37+
```{code-cell} ipython3
3838
:tags: [skip-execution]
3939
4040
# Login using the huggingface-cli utility

docs/catalysts/examples_tutorials/cattsunami_tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ else:
3535
3636
3737
1. Install the necessary packages using pip, uv etc
38-
```{code}
38+
```{code-cell} ipython3
3939
:tags: [skip-execution]
4040
4141
! pip install fairchem-core fairchem-data-oc fairchem-applications-cattsunami
@@ -47,7 +47,7 @@ else:
4747
* Create a Huggingface token at https://huggingface.co/settings/tokens/ with the permission "Permissions: Read access to contents of all public gated repos you can access"
4848
* Add the token as an environment variable using `huggingface-cli login` or by setting the HF_TOKEN environment variable.
4949
50-
```{code}
50+
```{code-cell} ipython3
5151
:tags: [skip-execution]
5252
5353
# Login using the huggingface-cli utility

docs/catalysts/examples_tutorials/ocpapi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Python library for programmatic use of the [Open Catalyst Demo](https://open-cat
2121
2222
2323
1. Install the necessary packages using pip, uv etc
24-
```{code}
24+
```{code-cell} ipython3
2525
:tags: [skip-execution]
2626
2727
! pip install fairchem-core fairchem-data-oc fairchem-applications-cattsunami
@@ -33,7 +33,7 @@ Python library for programmatic use of the [Open Catalyst Demo](https://open-cat
3333
* Create a Huggingface token at https://huggingface.co/settings/tokens/ with the permission "Permissions: Read access to contents of all public gated repos you can access"
3434
* Add the token as an environment variable using `huggingface-cli login` or by setting the HF_TOKEN environment variable.
3535
36-
```{code}
36+
```{code-cell} ipython3
3737
:tags: [skip-execution]
3838
3939
# Login using the huggingface-cli utility

docs/core/common_tasks/ase_calculator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ calc = FAIRChemCalculator(predictor, task_name="oc20")
3232
3333
3434
1. Install the necessary packages using pip, uv etc
35-
```{code}
35+
```{code-cell} ipython3
3636
:tags: [skip-execution]
3737
3838
! pip install fairchem-core fairchem-data-oc fairchem-applications-cattsunami
@@ -44,7 +44,7 @@ calc = FAIRChemCalculator(predictor, task_name="oc20")
4444
* Create a Huggingface token at https://huggingface.co/settings/tokens/ with the permission "Permissions: Read access to contents of all public gated repos you can access"
4545
* Add the token as an environment variable using `huggingface-cli login` or by setting the HF_TOKEN environment variable.
4646
47-
```{code}
47+
```{code-cell} ipython3
4848
:tags: [skip-execution]
4949
5050
# Login using the huggingface-cli utility

docs/core/common_tasks/batch_inference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
77
1. Install the necessary packages using pip, uv etc
8-
```{code}
8+
```{code-cell} ipython3
99
:tags: [skip-execution]
1010
1111
! pip install fairchem-core fairchem-data-oc fairchem-applications-cattsunami
@@ -17,7 +17,7 @@
1717
* Create a Huggingface token at https://huggingface.co/settings/tokens/ with the permission "Permissions: Read access to contents of all public gated repos you can access"
1818
* Add the token as an environment variable using `huggingface-cli login` or by setting the HF_TOKEN environment variable.
1919
20-
```{code}
20+
```{code-cell} ipython3
2121
:tags: [skip-execution]
2222
2323
# Login using the huggingface-cli utility

docs/core/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ appropriate task name for domain specific prediction.
3030
3131
3232
1. Install the necessary packages using pip, uv etc
33-
```{code}
33+
```{code-cell} ipython3
3434
:tags: [skip-execution]
3535
3636
! pip install fairchem-core fairchem-data-oc fairchem-applications-cattsunami
@@ -42,7 +42,7 @@ appropriate task name for domain specific prediction.
4242
* Create a Huggingface token at https://huggingface.co/settings/tokens/ with the permission "Permissions: Read access to contents of all public gated repos you can access"
4343
* Add the token as an environment variable using `huggingface-cli login` or by setting the HF_TOKEN environment variable.
4444
45-
```{code}
45+
```{code-cell} ipython3
4646
:tags: [skip-execution]
4747
4848
# Login using the huggingface-cli utility

docs/dac/examples_tutorials/adsorption_energy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Each term on the right-hand side represents the energy of the relaxed state of t
2929
3030
3131
1. Install the necessary packages using pip, uv etc
32-
```{code}
32+
```{code-cell} ipython3
3333
:tags: [skip-execution]
3434
3535
! pip install fairchem-core fairchem-data-oc fairchem-applications-cattsunami
@@ -41,7 +41,7 @@ Each term on the right-hand side represents the energy of the relaxed state of t
4141
* Create a Huggingface token at https://huggingface.co/settings/tokens/ with the permission "Permissions: Read access to contents of all public gated repos you can access"
4242
* Add the token as an environment variable using `huggingface-cli login` or by setting the HF_TOKEN environment variable.
4343
44-
```{code}
44+
```{code-cell} ipython3
4545
:tags: [skip-execution]
4646
4747
# Login using the huggingface-cli utility

0 commit comments

Comments
 (0)