Merge pull request #517 from prabhatnagarajan/collecct_demos_docs

Adds demonstration collection to experiments docs
chainer · Aug 9, 2019 · 29d6c74 · 29d6c74
2 parents 61f628d + 48ece26
commit 29d6c74
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/chainerrl/experiments/collect_demos.py b/chainerrl/experiments/collect_demos.py
@@ -18,7 +18,7 @@ def collect_demonstrations(agent,
                            outdir,
                            max_episode_len=None,
                            logger=None):
-    """Collects demonstrations from an agent and writes to a file.
+    """Collects demonstrations from an agent and writes them to a file.
 
     Args:
         agent: Agent from which demonstrations are collected.

diff --git a/docs/experiments.rst b/docs/experiments.rst
@@ -2,11 +2,20 @@
 Experiments
 ===========
 
+Collecting demonstrations
+=========================
+
+.. autofunction:: chainerrl.experiments.collect_demonstrations
+
 Training and evaluation
 =======================
 
 .. autofunction:: chainerrl.experiments.train_agent_async
 
+.. autofunction:: chainerrl.experiments.train_agent_batch
+
+.. autofunction:: chainerrl.experiments.train_agent_batch_with_evaluation
+
 .. autofunction:: chainerrl.experiments.train_agent_with_evaluation
 
 Training hooks