stable-baselines3/docs/guide
Bernhard Raml 15e94a6d14
Add support to log videos via tensorboard (#196)
* Add support to log videos via tensorboard

The ability to look at renderings of agent's trajectories during
training helps evaluate the performance of that agent. One can see what
the agent actually does at various stages during training. For now only
tensorboard is supported, as it is straightforward to implement.

* Remove moviepy dependency from extra & doc update

* Removed the moviepy dependency from the `extra` dependencies so the
user can decide whether to install it or not

* Update the video logging docu with proper naming, comments

* Added a warning to the video logging docu explaining the moviepy
dependency

* Updated the video test, to check for a warning when moviepy is missing

* Update doc

* Update FormatUnsupportedError message

* Also log the offending value making the error message more expressive

* Fix reporting the correct format and update regression test

* Use string description in FormatUnsupportedError

* Instead of converting the value to string without the user's control
the constructor takes a string representation of the value

* Use string description in FormatUnsupportedError

* Use a shorter string description for the error to reduce verbosity

Co-authored-by: Bernhard Raml <raml.bernhard@gmail.com>
Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2020-10-22 11:33:58 +02:00
..
algos.rst Implement DDPG (#92) 2020-07-16 14:14:22 +02:00
callbacks.rst Add StopTrainingOnMaxEpisodes to callback collection (#147) 2020-08-28 11:36:33 +02:00
checking_nan.rst Add base doc 2020-05-07 10:10:51 +02:00
custom_env.rst Add base doc 2020-05-07 10:10:51 +02:00
custom_policy.rst Add custom arch for off-policy actor/critic networks (#182) 2020-10-13 12:01:33 +02:00
developer.rst Review of code (A2C, PPO and refactoring) (#35) 2020-06-09 13:54:18 +02:00
examples.rst Rename cmd_util to env_util (#197) 2020-10-22 11:05:52 +02:00
install.rst Migration Guide (#123) 2020-10-11 23:22:12 +02:00
migration.rst Rename cmd_util to env_util (#197) 2020-10-22 11:05:52 +02:00
quickstart.rst [ci skip] Simplify quickstart example 2020-05-11 15:32:01 +02:00
rl.rst Add base doc 2020-05-07 10:10:51 +02:00
rl_tips.rst Update doc 2020-05-19 10:40:52 +02:00
rl_zoo.rst Update rl_zoo.rst (#72) 2020-06-25 12:14:56 +02:00
tensorboard.rst Add support to log videos via tensorboard (#196) 2020-10-22 11:33:58 +02:00
vec_envs.rst Add base doc 2020-05-07 10:10:51 +02:00