Make installation command compatible with ZSH by tom-doerr · Pull Request #376 · DLR-RM/stable-baselines3 (original) (raw)

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 andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation5 Commits5 Checks0 Files changed

Conversation

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters

[ Show hidden characters]({{ revealButtonHref }})

Description

This makes the command work in Zsh.

Motivation and Context

Command fails if package is not in quotation marks:

➜  stable-baselines3 git:(fix_extra_install_command) ✗ pip install stable-baselines3[extra]  
zsh: no matches found: stable-baselines3[extra]

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation (update in the documentation)

Checklist:

• I've read the CONTRIBUTION guide (required)
• I have updated the changelog accordingly (required).
• My change requires a change to the documentation.
• I have updated the tests accordingly (required for a bug fix or a new feature).
• I have updated the documentation accordingly.
• I have reformatted the code using make format (required)
• I have checked the codestyle using make check-codestyle and make lint (required)
• I have ensured make pytest and make type both pass. (required)
• I have checked that the documentation builds using make doc (required)

Note: You can run most of the checks using make commit-checks.

Note: we are using a maximum length of 127 characters per line

Hey! Please remember to fill in the steps in the checklist (changelog, contributors).

Regarding PR: rather than updating the example of pip install ... command, I would remove the quotation marks and add a comment right after it saying something like "Note: Some shells like Zsh require quotation marks around brackets, i.e. pip install [...]".

Adding a comment certainly makes sense when only few users are affected. However Zsh isn't the niche shell it used to be and now is even the default shell on Macs. Considering that, should I still add it as a comment?

Ah, good to know it has been set as default on Macs! :)

After discussing with @araffin we recommend to go with the "add a comment option" (a comment beside pip install command that tells to use this way on Zsh, along with a long to this stackoverflow answer in case users want to avoid similar errors in future). Update both installation documentation and README file.

Should be ready to merge now.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM =)

Next time, please open a "documentation" issue first ;)

araffin added a commit that referenced this pull request

May 3, 2021

• Start refactoring HER

• Fixes

• Additional fixes

• Faster tests

• WIP: HER as a custom replay buffer

• New replay only version (working with DQN)

• Add support for all off-policy algorithms

• Fix saving/loading

• Remove ObsDictWrapper and add VecNormalize tests with dict

• Stable-Baselines3 v1.0 (#354)

• Bump version and update doc

• Fix name

• Apply suggestions from code review

Co-authored-by: Adam Gleave adam@gleave.me

• Update docs/index.rst

Co-authored-by: Adam Gleave adam@gleave.me

• Update wording for RL zoo

Co-authored-by: Adam Gleave adam@gleave.me

• Add gym-pybullet-drones project (#358)

• Update projects.rst

Added gym-pybullet-drones

• Update projects.rst

Longer title underline

• Update changelog

Co-authored-by: Antonin Raffin antonin.raffin@ensta.org

• Include SuperSuit in projects (#359)

• include supersuit

• longer title underline

• Update changelog.rst

• Fix default arguments + add bugbear (#363)

• Fix potential bug + add bug bear

• Remove unused variables

• Minor: version bump

• Add code of conduct + update doc (#373)

• Add code of conduct

• Fix DQN doc example

• Update doc (channel-last/first)

• Apply suggestions from code review

Co-authored-by: Anssi kaneran21@hotmail.com

• Apply suggestions from code review

Co-authored-by: Adam Gleave adam@gleave.me

Co-authored-by: Anssi kaneran21@hotmail.com Co-authored-by: Adam Gleave adam@gleave.me

• Make installation command compatible with ZSH (#376)

• Add quotes

• Add Zsh bracket info

• Add clarify pip installation line

• Make note bold

• Add Zsh pip installation note

• Add handle timeouts param

• Fixes

• Fixes (buffer size, extend test)

• Fix max_episode_length redefinition

• Fix potential issue

• Add some docs on dict obs

• Fix performance bug

• Fix slowdown

• Add package to install (#378)

• Add package to install

• Update docs packages installation command

Co-authored-by: Antonin RAFFIN antonin.raffin@ensta.org

• Fix backward compat + add test

• Fix VecEnv detection

• Update doc

• Fix vec env check

• Support for VecMonitor for gym3-style environments (#311)

• add vectorized monitor

• auto format of the code

• add documentation and VecExtractDictObs

• refactor and add test cases

• add test cases and format

• avoid circular import and fix doc

• fix type

• fix type

• oops

• Update stable_baselines3/common/monitor.py

Co-authored-by: Antonin RAFFIN antonin.raffin@ensta.org

• Update stable_baselines3/common/monitor.py

Co-authored-by: Antonin RAFFIN antonin.raffin@ensta.org

• add test cases

• update changelog

• fix mutable argument

• quick fix

• Apply suggestions from code review

• fix terminal observation for gym3 envs

• delete comment

• Update doc and bump version

• Add warning when already using Monitor wrapper

• Update vecmonitor tests

• Fixes

Co-authored-by: Antonin RAFFIN antonin.raffin@ensta.org

• Reformat

• Fixed loading of ent_coef for SAC and TQC, it was not optimized anymore (#392)

• Fix ent coef loading bug

• Add test

• Add comment

• Reuse save path

• Add test for GAE + rename RolloutBuffer.dones for clarification (#375)

• Fix return computation + add test for GAE

• Rename last_dones to episode_starts for clarification

• Revert advantage

• Cleanup test

• Rename variable

• Clarify return computation

• Clarify docs

• Add multi-episode rollout test

• Reformat

Co-authored-by: Anssi "Miffyli" Kanervisto kaneran21@hotmail.com

• Fixed saving of A2C and PPO policy when using gSDE (#401)

• Improve doc and replay buffer loading

• Add support for images

• Fix doc

• Update Procgen doc

• Update changelog

• Update docstrings

Co-authored-by: Adam Gleave adam@gleave.me Co-authored-by: Jacopo Panerati jacopo.panerati@utoronto.ca Co-authored-by: Justin Terry justinkterry@gmail.com Co-authored-by: Anssi kaneran21@hotmail.com Co-authored-by: Tom Dörr tomdoerr96@gmail.com Co-authored-by: Tom Dörr tom.doerr@tum.de Co-authored-by: Costa Huang costa.huang@outlook.com

araffin added a commit that referenced this pull request

May 11, 2021

• First commit

• Fixing missing refs from a quick merge from master

• Reformat

• Adding DictBuffers

• Reformat

• Minor reformat

• added slow dict test. Added SACMultiInputPolicy for future. Added private static image transpose helper to common policy

• Ran black on buffers

• Ran isort

• Adding StackedObservations classes used within VecStackEnvs wrappers. Made test_dict_env shorter and removed slow

• Running isort :facepalm

• Fixed typing issues

• Adding docstrings and typing. Using util for moving data to device.

• Fixed trailing commas

• Fix types

• Minor edits

• Avoid duplicating code

• Fix calls to parents

• Adding assert to buffers. Updating changelong

• Running format on buffers

• Adding multi-input policies to dqn,td3,a2c. Fixing warnings. Fixed bug with DictReplayBuffer as Replay buffers use only 1 env

• Fixing warnings, splitting is_vectorized_observation into multiple functions based on space type

• Created envs folder in common. Updated imports. Moved stacked_obs to vec_env folder

• Moved envs to envs directory. Moved stacked obs to vec_envs. Started update on documentation

• Fixes

• Running code style

• Update docstrings on torch_layers

• Decapitalize non-constant variables

• Using NatureCNN architecture in combined extractor. Increasing img size in multi input env. Adding memory reduction in test

• Update doc

• Update doc

• Fix format

• Removing NineRoom env. Using nested preprocess. Removing mutable default args

• running code style

• Passing channel check through to stacked dict observations.

• Running black

• Adding channel control to SimpleMultiObsEnv. Passing check_channels to CombinedExtractor

• Remove optimize memory for dict buffers

• Update doc

• Move identity env

• Minor edits + bump version

• Update doc

• Fix doc build

• Bug fixes + add support for more type of dict env

• Fixes + add multi env test

• Add support for vectranspose

• Fix stacked obs for dict and add tests

• Add check for nested spaces. Fix dict-subprocvecenv test

• Fix (single) pytype error

• Simplify CombinedExtractor

• Fix tests

• Fix check

• Merge branch 'master' into feat/dict_observations

• Fix for net_arch with dict and vector obs

• Fixes

• Add consistency test

• Update env checker

• Add some docs on dict obs

• Update default CNN feature vector size

• Refactor HER (#351)

• Start refactoring HER

• Fixes

• Additional fixes

• Faster tests

• WIP: HER as a custom replay buffer

• New replay only version (working with DQN)

• Add support for all off-policy algorithms

• Fix saving/loading

• Remove ObsDictWrapper and add VecNormalize tests with dict

• Stable-Baselines3 v1.0 (#354)

• Bump version and update doc

• Fix name

• Apply suggestions from code review

Co-authored-by: Adam Gleave adam@gleave.me

• Update docs/index.rst

Co-authored-by: Adam Gleave adam@gleave.me

• Update wording for RL zoo

Co-authored-by: Adam Gleave adam@gleave.me

• Add gym-pybullet-drones project (#358)

• Update projects.rst

Added gym-pybullet-drones

• Update projects.rst

Longer title underline

• Update changelog

Co-authored-by: Antonin Raffin antonin.raffin@ensta.org

• Include SuperSuit in projects (#359)

• include supersuit

• longer title underline

• Update changelog.rst

• Fix default arguments + add bugbear (#363)

• Fix potential bug + add bug bear

• Remove unused variables

• Minor: version bump

• Add code of conduct + update doc (#373)

• Add code of conduct

• Fix DQN doc example

• Update doc (channel-last/first)

• Apply suggestions from code review

Co-authored-by: Anssi kaneran21@hotmail.com

• Apply suggestions from code review

Co-authored-by: Adam Gleave adam@gleave.me

Co-authored-by: Anssi kaneran21@hotmail.com Co-authored-by: Adam Gleave adam@gleave.me

• Make installation command compatible with ZSH (#376)

• Add quotes

• Add Zsh bracket info

• Add clarify pip installation line

• Make note bold

• Add Zsh pip installation note

• Add handle timeouts param

• Fixes

• Fixes (buffer size, extend test)

• Fix max_episode_length redefinition

• Fix potential issue

• Add some docs on dict obs

• Fix performance bug

• Fix slowdown

• Add package to install (#378)

• Add package to install

• Update docs packages installation command

Co-authored-by: Antonin RAFFIN antonin.raffin@ensta.org

• Fix backward compat + add test

• Fix VecEnv detection

• Update doc

• Fix vec env check

• Support for VecMonitor for gym3-style environments (#311)

• add vectorized monitor

• auto format of the code

• add documentation and VecExtractDictObs

• refactor and add test cases

• add test cases and format

• avoid circular import and fix doc

• fix type

• fix type

• oops

• Update stable_baselines3/common/monitor.py

Co-authored-by: Antonin RAFFIN antonin.raffin@ensta.org

• Update stable_baselines3/common/monitor.py

Co-authored-by: Antonin RAFFIN antonin.raffin@ensta.org

• add test cases

• update changelog

• fix mutable argument

• quick fix

• Apply suggestions from code review

• fix terminal observation for gym3 envs

• delete comment

• Update doc and bump version

• Add warning when already using Monitor wrapper

• Update vecmonitor tests

• Fixes

Co-authored-by: Antonin RAFFIN antonin.raffin@ensta.org

• Reformat

• Fixed loading of ent_coef for SAC and TQC, it was not optimized anymore (#392)

• Fix ent coef loading bug

• Add test

• Add comment

• Reuse save path

• Add test for GAE + rename RolloutBuffer.dones for clarification (#375)

• Fix return computation + add test for GAE

• Rename last_dones to episode_starts for clarification

• Revert advantage

• Cleanup test

• Rename variable

• Clarify return computation

• Clarify docs

• Add multi-episode rollout test

• Reformat

Co-authored-by: Anssi "Miffyli" Kanervisto kaneran21@hotmail.com

• Fixed saving of A2C and PPO policy when using gSDE (#401)

• Improve doc and replay buffer loading

• Add support for images

• Fix doc

• Update Procgen doc

• Update changelog

• Update docstrings

Co-authored-by: Adam Gleave adam@gleave.me Co-authored-by: Jacopo Panerati jacopo.panerati@utoronto.ca Co-authored-by: Justin Terry justinkterry@gmail.com Co-authored-by: Anssi kaneran21@hotmail.com Co-authored-by: Tom Dörr tomdoerr96@gmail.com Co-authored-by: Tom Dörr tom.doerr@tum.de Co-authored-by: Costa Huang costa.huang@outlook.com

• Update doc and minor fixes

• Update doc

• Added note about MultiInputPolicy in error of NatureCNN

• Merge branch 'master' into feat/dict_observations

• Address comments

• Naming clarifications

• Actually saving the file would be nice

• Fix edge case when doing online sampling with HER

• Cleanup

• Add sanity check

Co-authored-by: Antonin RAFFIN antonin.raffin@ensta.org Co-authored-by: Anssi "Miffyli" Kanervisto kaneran21@hotmail.com Co-authored-by: Adam Gleave adam@gleave.me Co-authored-by: Jacopo Panerati jacopo.panerati@utoronto.ca Co-authored-by: Justin Terry justinkterry@gmail.com Co-authored-by: Tom Dörr tomdoerr96@gmail.com Co-authored-by: Tom Dörr tom.doerr@tum.de Co-authored-by: Costa Huang costa.huang@outlook.com

leor-c pushed a commit to leor-c/stable-baselines3 that referenced this pull request

Aug 26, 2021

• Add quotes

• Add Zsh bracket info

• Add clarify pip installation line

• Make note bold

• Add Zsh pip installation note

leor-c pushed a commit to leor-c/stable-baselines3 that referenced this pull request

Aug 26, 2021

• First commit

• Fixing missing refs from a quick merge from master

• Reformat

• Adding DictBuffers

• Reformat

• Minor reformat

• added slow dict test. Added SACMultiInputPolicy for future. Added private static image transpose helper to common policy

• Ran black on buffers

• Ran isort

• Adding StackedObservations classes used within VecStackEnvs wrappers. Made test_dict_env shorter and removed slow

• Running isort :facepalm

• Fixed typing issues

• Adding docstrings and typing. Using util for moving data to device.

• Fixed trailing commas

• Fix types

• Minor edits

• Avoid duplicating code

• Fix calls to parents

• Adding assert to buffers. Updating changelong

• Running format on buffers

• Adding multi-input policies to dqn,td3,a2c. Fixing warnings. Fixed bug with DictReplayBuffer as Replay buffers use only 1 env

• Fixing warnings, splitting is_vectorized_observation into multiple functions based on space type

• Created envs folder in common. Updated imports. Moved stacked_obs to vec_env folder

• Moved envs to envs directory. Moved stacked obs to vec_envs. Started update on documentation

• Fixes

• Running code style

• Update docstrings on torch_layers

• Decapitalize non-constant variables

• Using NatureCNN architecture in combined extractor. Increasing img size in multi input env. Adding memory reduction in test

• Update doc

• Update doc

• Fix format

• Removing NineRoom env. Using nested preprocess. Removing mutable default args

• running code style

• Passing channel check through to stacked dict observations.

• Running black

• Adding channel control to SimpleMultiObsEnv. Passing check_channels to CombinedExtractor

• Remove optimize memory for dict buffers

• Update doc

• Move identity env

• Minor edits + bump version

• Update doc

• Fix doc build

• Bug fixes + add support for more type of dict env

• Fixes + add multi env test

• Add support for vectranspose

• Fix stacked obs for dict and add tests

• Add check for nested spaces. Fix dict-subprocvecenv test

• Fix (single) pytype error

• Simplify CombinedExtractor

• Fix tests

• Fix check

• Merge branch 'master' into feat/dict_observations

• Fix for net_arch with dict and vector obs

• Fixes

• Add consistency test

• Update env checker

• Add some docs on dict obs

• Update default CNN feature vector size

• Refactor HER (DLR-RM#351)

• Start refactoring HER

• Fixes

• Additional fixes

• Faster tests

• WIP: HER as a custom replay buffer

• New replay only version (working with DQN)

• Add support for all off-policy algorithms

• Fix saving/loading

• Remove ObsDictWrapper and add VecNormalize tests with dict

• Stable-Baselines3 v1.0 (DLR-RM#354)

• Bump version and update doc

• Fix name

• Apply suggestions from code review

Co-authored-by: Adam Gleave adam@gleave.me

• Update docs/index.rst

Co-authored-by: Adam Gleave adam@gleave.me

• Update wording for RL zoo

Co-authored-by: Adam Gleave adam@gleave.me

• Add gym-pybullet-drones project (DLR-RM#358)

• Update projects.rst

Added gym-pybullet-drones

• Update projects.rst

Longer title underline

• Update changelog

Co-authored-by: Antonin Raffin antonin.raffin@ensta.org

• Include SuperSuit in projects (DLR-RM#359)

• include supersuit

• longer title underline

• Update changelog.rst

• Fix default arguments + add bugbear (DLR-RM#363)

• Fix potential bug + add bug bear

• Remove unused variables

• Minor: version bump

• Add code of conduct + update doc (DLR-RM#373)

• Add code of conduct

• Fix DQN doc example

• Update doc (channel-last/first)

• Apply suggestions from code review

Co-authored-by: Anssi kaneran21@hotmail.com

• Apply suggestions from code review

Co-authored-by: Adam Gleave adam@gleave.me

Co-authored-by: Anssi kaneran21@hotmail.com Co-authored-by: Adam Gleave adam@gleave.me

• Make installation command compatible with ZSH (DLR-RM#376)

• Add quotes

• Add Zsh bracket info

• Add clarify pip installation line

• Make note bold

• Add Zsh pip installation note

• Add handle timeouts param

• Fixes

• Fixes (buffer size, extend test)

• Fix max_episode_length redefinition

• Fix potential issue

• Add some docs on dict obs

• Fix performance bug

• Fix slowdown

• Add package to install (DLR-RM#378)

• Add package to install

• Update docs packages installation command

Co-authored-by: Antonin RAFFIN antonin.raffin@ensta.org

• Fix backward compat + add test

• Fix VecEnv detection

• Update doc

• Fix vec env check

• Support for VecMonitor for gym3-style environments (DLR-RM#311)

• add vectorized monitor

• auto format of the code

• add documentation and VecExtractDictObs

• refactor and add test cases

• add test cases and format

• avoid circular import and fix doc

• fix type

• fix type

• oops

• Update stable_baselines3/common/monitor.py

Co-authored-by: Antonin RAFFIN antonin.raffin@ensta.org

• Update stable_baselines3/common/monitor.py

Co-authored-by: Antonin RAFFIN antonin.raffin@ensta.org

• add test cases

• update changelog

• fix mutable argument

• quick fix

• Apply suggestions from code review

• fix terminal observation for gym3 envs

• delete comment

• Update doc and bump version

• Add warning when already using Monitor wrapper

• Update vecmonitor tests

• Fixes

Co-authored-by: Antonin RAFFIN antonin.raffin@ensta.org

• Reformat

• Fixed loading of ent_coef for SAC and TQC, it was not optimized anymore (DLR-RM#392)

• Fix ent coef loading bug

• Add test

• Add comment

• Reuse save path

• Add test for GAE + rename RolloutBuffer.dones for clarification (DLR-RM#375)

• Fix return computation + add test for GAE

• Rename last_dones to episode_starts for clarification

• Revert advantage

• Cleanup test

• Rename variable

• Clarify return computation

• Clarify docs

• Add multi-episode rollout test

• Reformat

Co-authored-by: Anssi "Miffyli" Kanervisto kaneran21@hotmail.com

• Fixed saving of A2C and PPO policy when using gSDE (DLR-RM#401)

• Improve doc and replay buffer loading

• Add support for images

• Fix doc

• Update Procgen doc

• Update changelog

• Update docstrings

Co-authored-by: Adam Gleave adam@gleave.me Co-authored-by: Jacopo Panerati jacopo.panerati@utoronto.ca Co-authored-by: Justin Terry justinkterry@gmail.com Co-authored-by: Anssi kaneran21@hotmail.com Co-authored-by: Tom Dörr tomdoerr96@gmail.com Co-authored-by: Tom Dörr tom.doerr@tum.de Co-authored-by: Costa Huang costa.huang@outlook.com

• Update doc and minor fixes

• Update doc

• Added note about MultiInputPolicy in error of NatureCNN

• Merge branch 'master' into feat/dict_observations

• Address comments

• Naming clarifications

• Actually saving the file would be nice

• Fix edge case when doing online sampling with HER

• Cleanup

• Add sanity check

Co-authored-by: Antonin RAFFIN antonin.raffin@ensta.org Co-authored-by: Anssi "Miffyli" Kanervisto kaneran21@hotmail.com Co-authored-by: Adam Gleave adam@gleave.me Co-authored-by: Jacopo Panerati jacopo.panerati@utoronto.ca Co-authored-by: Justin Terry justinkterry@gmail.com Co-authored-by: Tom Dörr tomdoerr96@gmail.com Co-authored-by: Tom Dörr tom.doerr@tum.de Co-authored-by: Costa Huang costa.huang@outlook.com