stable-baselines3/docs
liorcohen5 f5104a5efc
Allow to set a device when loading a model (#154)
* Added a 'device' keyword argument to BaseAlgorithm.load().
Edited the save and load test to also test the load method with all possible devices.
Added the changes to the changelog

* improved the load test to ensure that the model loads to the correct device.

* improved the test: now the correctness is improved. If the get_device policy would change, it wouldn't break the test.

* Update tests/test_save_load.py

@araffin's suggestion during the PR process

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

* Update tests/test_save_load.py

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

* Bug fixes: when comparing devices, comparing only device type since get_device() doesn't provide device index.
Now the code loads all of the model parameters from the saved state dict straight into the required device. (fixed load_from_zip_file).

* PR fixes: bug fix - a non-related test failed when running on GPU. updated the assertion to consider only types of devices. Also corrected a related bug in 'get_device()' method.

* Update changelog.rst

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2020-09-20 19:13:18 +02:00
..
_static Tensorboard integration (#30) 2020-06-01 11:55:44 +02:00
common Update doc 2020-05-19 10:40:52 +02:00
guide Add StopTrainingOnMaxEpisodes to callback collection (#147) 2020-08-28 11:36:33 +02:00
misc Allow to set a device when loading a model (#154) 2020-09-20 19:13:18 +02:00
modules Match performance with stable-baselines (discrete case) (#110) 2020-08-03 22:22:51 +02:00
conda_env.yml Use conda env for building the doc (#16) 2020-05-11 17:39:41 +02:00
conf.py Auto-formatting with black and isort (#97) 2020-07-16 16:12:16 +02:00
index.rst Remove "device" argument from policies (#141) 2020-08-23 13:27:52 +02:00
make.bat Add doc 2019-09-26 11:46:40 +02:00
Makefile Add doc 2019-09-26 11:46:40 +02:00
README.md Add base doc 2020-05-07 10:10:51 +02:00
spelling_wordlist.txt Implement DDPG (#92) 2020-07-16 14:14:22 +02:00

Stable Baselines3 Documentation

This folder contains documentation for the RL baselines.

Build the Documentation

Install Sphinx and Theme

pip install sphinx sphinx-autobuild sphinx-rtd-theme

Building the Docs

In the docs/ folder:

make html

if you want to building each time a file is changed:

sphinx-autobuild . _build/html