saymrwulf/stable-baselines3
1
0
Fork 0
mirror of https://github.com/saymrwulf/stable-baselines3.git synced 2026-09-17 22:30:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Make installation command compatible with ZSH (#376)

Browse source 
* Add quotes

* Add Zsh bracket info

* Add clarify pip installation line

* Make note bold

* Add Zsh pip installation note
This commit is contained in:
Tom Dörr 2021-04-02 20:46:36 +02:00 committed by GitHub
parent ba73d152d5
commit c0966f3745
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -93,6 +93,7 @@ Install the Stable Baselines3 package:
``` ```
pip install stable-baselines3[extra] pip install stable-baselines3[extra]
``` ```
**Note:** Some shells such as Zsh require quotation marks around brackets, i.e. `pip install 'stable-baselines3[extra]'` ([More Info](https://stackoverflow.com/a/30539963)).
This includes an optional dependencies like Tensorboard, OpenCV or `atari-py` to train on atari games. If you do not need those, you can use: This includes an optional dependencies like Tensorboard, OpenCV or `atari-py` to train on atari games. If you do not need those, you can use:
``` ```

4
docs/guide/install.rst
View file

@ -29,6 +29,10 @@ To install Stable Baselines3 with pip, execute:
pip install stable-baselines3[extra] pip install stable-baselines3[extra]
.. note::
Some shells such as Zsh require quotation marks around brackets, i.e. ``pip install 'stable-baselines3[extra]'`` `More information <https://stackoverflow.com/a/30539963>`_.
This includes an optional dependencies like Tensorboard, OpenCV or ``atari-py`` to train on atari games. If you do not need those, you can use: This includes an optional dependencies like Tensorboard, OpenCV or ``atari-py`` to train on atari games. If you do not need those, you can use:
.. code-block:: bash .. code-block:: bash

3
docs/misc/changelog.rst
View file

@ -31,6 +31,7 @@ Documentation:
- Added link to SuperSuit in projects (@justinkterry) - Added link to SuperSuit in projects (@justinkterry)
- Fixed DQN example (thanks @ltbd78) - Fixed DQN example (thanks @ltbd78)
- Clarify channel-first/channel-last recommendation - Clarify channel-first/channel-last recommendation
- Clarify pip installation in Zsh (@tom-doerr)
Release 1.0 (2021-03-15) Release 1.0 (2021-03-15)
@ -640,4 +641,4 @@ And all the contributors:
@tirafesi @blurLake @koulakis @joeljosephjin @shwang @rk37 @andyshih12 @RaphaelWag @xicocaio @tirafesi @blurLake @koulakis @joeljosephjin @shwang @rk37 @andyshih12 @RaphaelWag @xicocaio
@diditforlulz273 @liorcohen5 @ManifoldFR @mloo3 @SwamyDev @wmmc88 @megan-klaiber @thisray @diditforlulz273 @liorcohen5 @ManifoldFR @mloo3 @SwamyDev @wmmc88 @megan-klaiber @thisray
@tfederico @hn2 @LucasAlegre @AptX395 @zampanteymedio @decodyng @ardabbour @lorenz-h @mschweizer @lorepieri8 @tfederico @hn2 @LucasAlegre @AptX395 @zampanteymedio @decodyng @ardabbour @lorenz-h @mschweizer @lorepieri8
@ShangqunYu @PierreExeter @JacopoPan @ltbd78 @ShangqunYu @PierreExeter @JacopoPan @ltbd78 @tom-doerr