Skip to content

Commit

Permalink
Add file structure to index.rst.
Browse files Browse the repository at this point in the history
  • Loading branch information
qiuwch committed May 17, 2017
1 parent eb79977 commit d511f23
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
===============================
Welcome to VDL's documentation!
===============================

Expand All @@ -16,6 +17,34 @@ This documentation documents how to reproduce the result in the VDL project.

The final presentation is hosted `here <https://docs.google.com/presentation/d/1r4zVv6bnImt8xTVtxopYhg1lWAeXrgliMfQQTo5Nlng/edit?usp=sharing>`__

Files in this project
=====================

.. code-block:: bash
# Main
docs/ # Documentation files in reStructuredText format
universe-starter-agent/ # Virtual distributed learning system, the code is
# modified from https://github.com/openai/universe-starter-agent, which
# provides the baseline learning algorithm.
# Components
learner-actor/ # Experiment code for learner-actor communication
tensorflow_MNIST/ # Experiment code for P2P-multi-learner
# Utility
gym-demo/ # Virtual environnment demos to make sure the dev
# boxs are correctly configured.
benchmark/ # Benchmark code to evaluate the network speed and
# speed of different virtual environments
neonrace/ # Code to run trained neonrace auto-driving model
spread/ # Compiled spread and its python wrapper
# Virtual arm
arm-pose/ # Pose estimation code trained on the virtual arm
# and test on the real arm.
owi-arm/ # Code to control real and the virtual arm
.. toctree::
:maxdepth: 2
:caption: Contents:
Expand Down

0 comments on commit d511f23

Please sign in to comment.