CI instructions

Summary: Add a page for CI instructions

Reviewed By: czxttkl

Differential Revision: D17983742

fbshipit-source-id: 31479a349310a55844cea7ea97629fcd96d5b1b6

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to Horizon
+# Contributing to ReAgent
 We want to make contributing to this project as easy and transparent as
 possible.
 
@@ -23,5 +23,5 @@ We use GitHub issues to track public bugs. Please ensure your description is
 clear and has sufficient instructions to be able to reproduce the issue.
 
 ## License
-By contributing Horizon, you agree that your contributions will be licensed
+By contributing ReAgent, you agree that your contributions will be licensed
 under the LICENSE file in the root directory of this source tree.

LICENSE

@@ -1,6 +1,6 @@
 BSD License
 
-For Horizon software
+For ReAgent software
 
 Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
 

docs/conf.py

@@ -21,9 +21,9 @@ sys.path.insert(0, os.path.abspath("../"))
 # -- Project information -----------------------------------------------------
 
 
-project = "Horizon"
+project = "ReAgent"
 copyright = "2019, Facebook Inc."
-author = "Horizon Team"
+author = "ReAgent Team"
 
 # The full version, including alpha/beta/rc tags
 release = "1.0"

docs/continuous_integration.rst

@@ -0,0 +1,20 @@
+.. _continuous_integration:
+
+Continuous Integration
+======================
+
+We have CI setup on `CircleCI <https://circleci.com/gh/facebookresearch/ReAgent>`_.
+It's a pretty basic setup. One key thing to note is that dependencies are baked into our Docker images.
+If you need a new dependency, you will have to rebuild Docker images, upload them to Docker hub, and update ``.circleci/config.yml`` accordingly.
+Here are the steps:
+
+.. code-block::
+   docker build -f docker/cpu.Dockerfile -t reagent:cpu .
+   docker tag reagent:cpu kittipatv/reagent:cpu_test
+   docker push kittipatv/reagent:cpu_test
+
+If you cannot push, you have to run ``docker login``.
+
+Then, you should follow the local testing instructions in ``.circleci/config.yml`` to make sure that the new Docker image is in a good shape.
+Once you are sure, tag the image without ``_test`` suffix and push again.
+If you weren't the last person to update the images, then you will have to submit a PR to update the image names.

docs/index.rst

@@ -11,9 +11,8 @@ ReAgent: Applied Reinforcement Learning Platform
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
-.. image:: https://ci.pytorch.org/jenkins/buildStatus/icon?job=horizon-master
-   :target: https://ci.pytorch.org/jenkins/job/horizon-master/
-   :alt: Build Status
+.. image:: https://circleci.com/gh/facebookresearch/ReAgent/tree/master.svg?style=svg
+    :target: https://circleci.com/gh/facebookresearch/ReAgent/tree/master
 
 --------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
@@ -26,7 +25,7 @@ workflows to train popular deep RL algorithms and includes data preprocessing, f
 counterfactual policy evaluation, and optimized serving. For more detailed information about ReAgent see the white
 paper here: `Platform <https://research.fb.com/publications/horizon-facebooks-open-source-applied-reinforcement-learning-platform/>`_.
 
-The source code is available here: `Source code <https://github.com/facebookresearch/Horizon>`_.
+The source code is available here: `Source code <https://github.com/facebookresearch/ReAgent>`_.
 
 The platform was once named "Horizon" but we have adopted the name "ReAgent" recently to emphasize its broader scope in decision making and reasoning.
 
@@ -83,6 +82,7 @@ Table of Contents
     :caption: Advanced Topics
 
     Distributed Training <distributed>
+    Continuous Integration <continuous_integration>
 
 .. toctree::
     :caption: Package Reference