stable-baselines3/docs/modules/base.rst
Anssi 44f8218df0
Review of code (A2C, PPO and refactoring) (#35)
* Split torch module code into torch_layers file

* Updated reference to CNN

* Change 'CxWxH' to 'CxHxW', as per common notion

* Fix missing import in policies.py

* Move PPOPolicy to OnlineActorCriticPolicy

* Create OnPolicyRLModel from PPO, and make A2C and PPO inherit

* Update A2C optimizer comment

* Clean weight init scales for clarity

* Fix A2C log_interval default parameter

* Rename 'progress' to 'progress_remaining

* Rename 'Models' to 'Algorithms'

* Rename 'OnlineActorCriticPolicy' to 'ActorCriticPolicy'

* Move static functions out from BaseAlgorithm

* Move on/off_policy base algorithms to their own files

* Add  files for A2C/PPO

* Fix docs

* Fix pytype

* Update documentation on OnPolicyAlgorithm

* Add proper doctstring for on_policy rollout gathering

* Add bit clarification on the mlppolicy/cnnpolicy naming

* Move static function is_vectorized_policies to utils.py

* Checking docstrings, pep8 fixes

* Update changelog

* Clean changelog

* Remove policy warnings for sac/td3

* Add monitor_wrapper for OnPolicyAlgorithm. Clean tb logging variables. Add parameter keywords to OffPolicyAlgorithm super init

Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
2020-06-09 13:54:18 +02:00

36 lines
618 B
ReStructuredText

.. _base_algo:
.. automodule:: stable_baselines3.common.base_class
Base RL Class
=============
Common interface for all the RL algorithms
.. autoclass:: BaseAlgorithm
:members:
.. automodule:: stable_baselines3.common.off_policy_algorithm
Base Off-Policy Class
^^^^^^^^^^^^^^^^^^^^^
The base RL algorithm for Off-Policy algorithm (ex: SAC/TD3)
.. autoclass:: OffPolicyAlgorithm
:members:
.. automodule:: stable_baselines3.common.on_policy_algorithm
Base On-Policy Class
^^^^^^^^^^^^^^^^^^^^^
The base RL algorithm for On-Policy algorithm (ex: A2C/PPO)
.. autoclass:: OnPolicyAlgorithm
:members: