Skip to content

Commit

Permalink
Minor documentation changes (typo ressource and link to `custom_env…
Browse files Browse the repository at this point in the history
…s`) (#744)

* Minor changes (typo and link)

Typo correction: `resource` instead of `ressource`
Link correction: to Using Custom Environments page (`custom_env` instead of `custom_envs`).

* Update changelog

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
  • Loading branch information
caburu and araffin committed Mar 21, 2020
1 parent 3069a0e commit e24c380
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/guide/rl_tips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ TL;DR
4. For better performance, increase the training budget


Like any other subject, if you want to work with RL, you should first read about it (we have a dedicated `ressource page <rl.html>`_ to get you started)
Like any other subject, if you want to work with RL, you should first read about it (we have a dedicated `resource page <rl.html>`_ to get you started)
to understand what you are using. We also recommend you read Stable Baselines (SB) documentation and do the `tutorial <https://github.com/araffin/rl-tutorial-jnrr19>`_.
It covers basic usage and guide you towards more advanced concepts of the library (e.g. callbacks and wrappers).

Expand Down Expand Up @@ -165,7 +165,7 @@ HER + (SAC/TD3/DDPG/DQN) depending on the action space.
Tips and Tricks when creating a custom environment
==================================================

If you want to learn about how to create a custom environment, we recommend you read this `page <custom_envs.html>`_.
If you want to learn about how to create a custom environment, we recommend you read this `page <custom_env.html>`_.
We also provide a `colab notebook <https://colab.research.google.com/github/araffin/rl-tutorial-jnrr19/blob/master/5_custom_gym_env.ipynb>`_ for
a concrete example of creating a custom gym environment.

Expand Down
3 changes: 2 additions & 1 deletion docs/misc/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Others:

Documentation:
^^^^^^^^^^^^^^
- Fix typos (@caburu)


Release 2.10.0 (2020-03-11)
Expand Down Expand Up @@ -682,4 +683,4 @@ Thanks to @bjmuld @iambenzo @iandanforth @r7vme @brendenpetersen @huvar @abhiskk
@XMaster96 @kantneel @Pastafarianist @GerardMaggiolino @PatrickWalter214 @yutingsz @sc420 @Aaahh @billtubbs
@Miffyli @dwiel @miguelrass @qxcv @jaberkow @eavelardev @ruifeng96150 @pedrohbtp @srivatsankrishnan @evilsocket
@MarvineGothic @jdossgollin @SyllogismRXS @rusu24edward @jbulow @Antymon @seheevic @justinkterry @edbeeching
@flodorner @KuKuXia @NeoExtended @solliet @mmcenta @richardwu @tirafesi
@flodorner @KuKuXia @NeoExtended @solliet @mmcenta @richardwu @tirafesi @caburu

0 comments on commit e24c380

Please sign in to comment.