mirror of
https://github.com/gryf/coach.git
synced 2026-02-14 21:15:53 +01:00
update of api docstrings across coach and tutorials [WIP] (#91)
* updating the documentation website * adding the built docs * update of api docstrings across coach and tutorials 0-2 * added some missing api documentation * New Sphinx based documentation
This commit is contained in:
72
docs_raw/source/index.rst
Normal file
72
docs_raw/source/index.rst
Normal file
@@ -0,0 +1,72 @@
|
||||
.. Reinforcement Learning Coach documentation master file, created by
|
||||
sphinx-quickstart on Sun Oct 28 15:35:09 2018.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
|
||||
Reinforcement Learning Coach
|
||||
============================
|
||||
|
||||
Coach is a python framework which models the interaction between an agent and an environment in a modular way.
|
||||
With Coach, it is possible to model an agent by combining various building blocks, and training the agent on multiple environments.
|
||||
The available environments allow testing the agent in different fields such as robotics, autonomous driving, games and more.
|
||||
It exposes a set of easy-to-use APIs for experimenting with new RL algorithms, and allows simple integration of
|
||||
new environments to solve.
|
||||
Coach collects statistics from the training process and supports advanced visualization techniques for debugging the agent being trained.
|
||||
|
||||
.. image:: _static/img/design.png
|
||||
:width: 800px
|
||||
|
||||
Blog posts from the Intel® AI website:
|
||||
|
||||
* `Release 0.8.0 <https://ai.intel.com/reinforcement-learning-coach-intel/>`_ (initial release)
|
||||
|
||||
* `Release 0.9.0 <https://ai.intel.com/reinforcement-learning-coach-carla-qr-dqn/>`_
|
||||
|
||||
* `Release 0.10.0 <https://ai.intel.com/introducing-reinforcement-learning-coach-0-10-0/)>`_
|
||||
|
||||
* `Release 0.11.0 <https://ai.intel.com/>`_ (current release)
|
||||
|
||||
You can find more details in the `GitHub repository <https://github.com/NervanaSystems/coach>`_.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Intro
|
||||
:titlesonly:
|
||||
|
||||
usage
|
||||
features/index
|
||||
selecting_an_algorithm
|
||||
dashboard
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Design
|
||||
|
||||
design/control_flow
|
||||
design/network
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Contributing
|
||||
|
||||
contributing/add_agent
|
||||
contributing/add_env
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Components
|
||||
|
||||
components/agents/index
|
||||
components/architectures/index
|
||||
components/environments/index
|
||||
components/exploration_policies/index
|
||||
components/filters/index
|
||||
components/memories/index
|
||||
components/core_types
|
||||
components/spaces
|
||||
components/additional_parameters
|
||||
|
||||
|
||||
Reference in New Issue
Block a user