saymrwulf/stable-baselines3
1
0
Fork 0
mirror of https://github.com/saymrwulf/stable-baselines3.git synced 2026-06-03 23:49:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Link to full imitation docs (#1106)

Browse source
This commit is contained in:
Sam Toyer 2022-10-10 21:36:30 -07:00 committed by GitHub
parent 4a558dd8ff
commit 5e8f06b3cb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
docs/guide/imitation.rst
View file

@ -10,46 +10,10 @@ imitation learning algorithms on top of Stable-Baselines3, including:
- `DAgger <https://arxiv.org/abs/1011.0686>`_ with synthetic examples
- `Adversarial Inverse Reinforcement Learning <https://arxiv.org/abs/1710.11248>`_ (AIRL)
- `Generative Adversarial Imitation Learning <https://arxiv.org/abs/1606.03476>`_ (GAIL)
- `Deep RL from Human Preferences <https://arxiv.org/abs/1706.03741>`_ (DRLHP)
It also provides `CLI scripts <#cli-quickstart>`_ for training and saving
demonstrations from RL experts, and for training imitation learners on these demonstrations.
Installation
------------
Installation requires Python 3.7+:
::
pip install imitation
CLI Quickstart
---------------------
::
# Train PPO agent on cartpole and collect expert demonstrations
python -m imitation.scripts.expert_demos with fast cartpole log_dir=quickstart
# Train GAIL from demonstrations
python -m imitation.scripts.train_adversarial with fast gail cartpole rollout_path=quickstart/rollouts/final.pkl
# Train AIRL from demonstrations
python -m imitation.scripts.train_adversarial with fast airl cartpole rollout_path=quickstart/rollouts/final.pkl
.. note::
You can remove the ``fast`` option to run training to completion. For more CLI options
and information on reading Tensorboard plots, see the
`README <https://github.com/HumanCompatibleAI/imitation#cli-quickstart>`_.
Python Interface Quickstart
---------------------------
This `example script <https://github.com/HumanCompatibleAI/imitation/blob/master/examples/quickstart.py>`_
uses the Python API to train BC, GAIL, and AIRL models on CartPole data.
You can install imitation with ``pip install imitation``. The `imitation
documentation <https://imitation.readthedocs.io/en/latest/>`_ has more details
on how to use the library, including `a quick start guide
<https://imitation.readthedocs.io/en/latest/getting-started/first-steps.html>`_
for the impatient.