Skip to content

Commit

Permalink
Minor fixes to docs (#118)
Browse files Browse the repository at this point in the history
* fix link typo

* cli doc typo

* minari version dataset docs

---------

Co-authored-by: rodrigodelazcano <[email protected]>
  • Loading branch information
rodrigodelazcano and rodrigodelazcano authored Jul 18, 2023
1 parent 41a22a0 commit b702a05
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/_scripts/gen_dataset_md.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
email = dataset_spec["author_email"]
algo_name = dataset_spec["algorithm_name"]
code = dataset_spec["code_permalink"]
minari_version = dataset_spec["minari_version"]

description = None
if "description" in dataset_spec:
Expand Down Expand Up @@ -112,6 +113,7 @@
| Author | `{author}` |
| Email | `{email}` |
| Code Permalink | `{code}` |
| Minari Version | `{minari_version}` |
| download | `minari.download_dataset("{dataset_id}")` |
Expand Down
2 changes: 1 addition & 1 deletion docs/content/minari_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ current content of the local dataset.
```{eval-rst}
.. note::
The download is aborted if the remote dataset is not compatible with your local installed Minari version or through a warning if the dataset already exists locally. To perform a force download add :code:`--force` or :code: `-f` to the download command.
The download is aborted if the remote dataset is not compatible with your local installed Minari version or through a warning if the dataset already exists locally. To perform a force download add :code:`--force` or :code:`-f` to the download command.
```

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/using_datasets/behavioral_cloning.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# %%
# Policy training
# ~~~~~~~~~~~~~~~~~~~
# To train the expert policy, we use `SB3 <https://github.com/DLR-RM/stable-baselines3>`_'s <rl-zoo3 <https://github.com/DLR-RM/rl-baselines3-zoo>`_ library.
# To train the expert policy, we use `SB3 <https://github.com/DLR-RM/stable-baselines3>`_'s `rl-zoo3 <https://github.com/DLR-RM/rl-baselines3-zoo>`_ library.
# After installing the library with ``pip install rl_zoo3``,
# we train a PPO agent on the environment with the following command:
#
Expand Down

0 comments on commit b702a05

Please sign in to comment.