Add warning when using PPO on GPU and update doc #2017
Merged
+56
−4
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes issue #2012.
Added comment to PPO documentation that CPU should primarily be used unless using CNN as well as sample code. Added warning to user for both PPO and A2C that CPU should be used if the user is running GPU without using a CNN, reference Issue #1245.
Description
Added lines 91-107 of docs/modules/ppo.rst to explain that PPO should use CPU rather than GPU unless using CNN. Gave a code example just like in A2C documentation.
Added lines 122-134 to stable_baselines/a2c/a2c.py to give error if the device is not cpu and the policy is not CNN, this only warns the user.
Added lines 137-149 to stable_baselines/ppo/ppo.py to give error if the device is not cpu and the policy is not CNN, this only warns the user.
Motivation and Context
Closes issue #2012.
Types of changes
Checklist
make format
(required)make check-codestyle
andmake lint
(required)make pytest
andmake type
both pass. (required)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