From ddc97864dfcc772b54dc8e4569e967ba0c6c8756 Mon Sep 17 00:00:00 2001
From: Eric Liang <ekhliang@gmail.com>
Date: Sat, 22 Dec 2018 04:02:02 +0900
Subject: [PATCH] [rllib] Add requested clarifications to test requirement of
 contrib docs (#3589)

---
 doc/source/rllib-dev.rst            | 6 +++---
 python/ray/rllib/contrib/README.rst | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/source/rllib-dev.rst b/doc/source/rllib-dev.rst
index 6cd148880..aba1589d3 100644
--- a/doc/source/rllib-dev.rst
+++ b/doc/source/rllib-dev.rst
@@ -9,7 +9,7 @@ Feature development and upcoming priorities are tracked on the `RLlib project bo
 Benchmarks
 ----------
 
-Currently we host a number of full training run results in the `rl-experiments repo <https://github.com/ray-project/rl-experiments>`__, and maintain a list of working hyperparameter configurations in `tuned_examples <https://github.com/ray-project/ray/tree/master/python/ray/rllib/tuned_examples>`__. Benchmark results are extremely valuable to the community, so if you happen to have results that may be of interest, consider making a pull request to either repo.
+A number of training run results are available in the `rl-experiments repo <https://github.com/ray-project/rl-experiments>`__, and there is also a list of working hyperparameter configurations in `tuned_examples <https://github.com/ray-project/ray/tree/master/python/ray/rllib/tuned_examples>`__. Benchmark results are extremely valuable to the community, so if you happen to have results that may be of interest, consider making a pull request to either repo.
 
 Contributing Algorithms
 -----------------------
@@ -18,7 +18,7 @@ These are the guidelines for merging new algorithms into RLlib:
 
 * Contributed algorithms (`rllib/contrib <https://github.com/ray-project/ray/tree/master/python/ray/rllib/contrib>`__):
     - must subclass Agent and implement the ``_train()`` method
-    - must include a lightweight test (<30s to run) to sanity check functionality
+    - must include a lightweight test (`example <https://github.com/ray-project/ray/blob/6bb110393008c9800177490688c6ed38b2da52a9/test/jenkins_tests/run_multi_node_tests.sh#L45>`__) to ensure the algorithm runs
     - should include tuned hyperparameter examples and documentation
     - should offer functionality not present in existing algorithms
 
@@ -49,7 +49,7 @@ Second, register the agent with a name in `contrib/registry.py <https://github.c
 
     def _import_random_agent_2():
         from ray.rllib.contrib.random_agent_2.random_agent_2 import RandomAgent2
-        return RandomAgent
+        return RandomAgent2
 
     CONTRIBUTED_ALGORITHMS = {
         "contrib/RandomAgent": _import_random_agent,
diff --git a/python/ray/rllib/contrib/README.rst b/python/ray/rllib/contrib/README.rst
index 27f755f2a..0532a4767 100644
--- a/python/ray/rllib/contrib/README.rst
+++ b/python/ray/rllib/contrib/README.rst
@@ -1,3 +1,3 @@
-Contributed algorithms, which can be run via `rllib train --run=contrib/<alg_name>`
+Contributed algorithms, which can be run via ``rllib train --run=contrib/<alg_name>``
 
 See https://ray.readthedocs.io/en/latest/rllib-dev.html for guidelines.