123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136 |
- .. _rlmodule-reference-docs:
- RLModule API
- ============
- RL Module specifications and configuraitons
- -------------------------------------------
- Single Agent
- ++++++++++++
- .. currentmodule:: ray.rllib.core.rl_module.rl_module
- .. autosummary::
- :toctree: doc/
- SingleAgentRLModuleSpec
- SingleAgentRLModuleSpec.build
- SingleAgentRLModuleSpec.get_rl_module_config
- RLModule Configuration
- +++++++++++++++++++++++
- .. autosummary::
- :toctree: doc/
- RLModuleConfig
- RLModuleConfig.to_dict
- RLModuleConfig.from_dict
- RLModuleConfig.get_catalog
- Multi Agent
- ++++++++++++
- .. currentmodule:: ray.rllib.core.rl_module.marl_module
- .. autosummary::
- :toctree: doc/
- MultiAgentRLModuleSpec
- MultiAgentRLModuleSpec.build
- MultiAgentRLModuleSpec.get_marl_config
- RL Module API
- -------------
- .. currentmodule:: ray.rllib.core.rl_module.rl_module
- Constructor
- +++++++++++
- .. autosummary::
- :toctree: doc/
- RLModule
- RLModule.as_multi_agent
- Forward methods
- +++++++++++++++
- .. autosummary::
- :toctree: doc/
- ~RLModule.forward_train
- ~RLModule.forward_exploration
- ~RLModule.forward_inference
- IO specifications
- +++++++++++++++++
- .. autosummary::
- :toctree: doc/
- ~RLModule.input_specs_inference
- ~RLModule.input_specs_exploration
- ~RLModule.input_specs_train
- ~RLModule.output_specs_inference
- ~RLModule.output_specs_exploration
- ~RLModule.output_specs_train
- Saving and Loading
- ++++++++++++++++++++++
- .. autosummary::
- :toctree: doc/
- ~RLModule.get_state
- ~RLModule.set_state
- ~RLModule.save_state
- ~RLModule.load_state
- ~RLModule.save_to_checkpoint
- ~RLModule.from_checkpoint
- Multi Agent RL Module API
- -------------------------
- .. currentmodule:: ray.rllib.core.rl_module.marl_module
- Constructor
- +++++++++++
- .. autosummary::
- :toctree: doc/
- MultiAgentRLModule
- MultiAgentRLModule.setup
- MultiAgentRLModule.as_multi_agent
- Modifying the underlying RL modules
- ++++++++++++++++++++++++++++++++++++
- .. autosummary::
- :toctree: doc/
- ~MultiAgentRLModule.add_module
- ~MultiAgentRLModule.remove_module
- Saving and Loading
- ++++++++++++++++++++++
- .. autosummary::
- :toctree: doc/
- ~MultiAgentRLModule.save_state
- ~MultiAgentRLModule.load_state
|