Merge pull request #714 from NextCenturyCorporation/MCS-1991

MCS-1991 Cleaned Up Documentation and Added Task List Page

docs/source/dev.rst

@@ -81,6 +81,12 @@ Sphinx Documentation
 - Sphinx: https://www.sphinx-doc.org/en/master/
 - Sphinx's own Tutorial: https://www.sphinx-doc.org/en/master/usage/quickstart.html
 
+To generate the Sphinx documentation locally, from the docs folder:
+
+.. code-block:: console
+
+    (mcs) $ make html
+
 Python Style Guide
 ------------------
 
@@ -151,14 +157,6 @@ team
 
 Team name identifier to prefix to scene history and video files (default: '').
 
-timeout
-^^^^^^^
-
-(int, optional)
-
-If the amount of time between steps exceeds the amount specified (represented in seconds), throw and error and attempt to end scene (default: 3600 (or 1 hour)).
-
-
 Handling Pull Requests From Contributors
 ----------------------------------------
 

docs/source/index.rst

@@ -12,7 +12,6 @@ Machine Common Sense Documentation
     api
     scenes
     schema
-    training
     models
     containerize
     remotely

docs/source/install.rst

@@ -121,33 +121,33 @@ To use a specific configuration, you can either pass in a file path or dictionar
 Config File Properties
 **********************
 
-only_return_goal_object
-^^^^^^^^^^^^^^^
+controller_timeout
+^^^^^^^^^^^^^^^^^^
 
-(boolean, optional)
+(int, optional)
 
-If `true`, only returns the goal object from the object list output in the metadata. Metadata Tier will override `only_return_goal_object`. Default: false
+Sets the time (in seconds) to allow on controller initialization before timing out. Default 600
 
-disable_position
+disable_depth_maps
 ^^^^^^^^^^^^^^^
 
 (boolean, optional)
 
-If `true`, does not generate position information output in the metadata. Metadata Tier will override `disable_position`. Default: false
+If `false`, will generate depth maps. Metadata Tier will override `disable_depth_maps`. Will only generate depth maps for Metadata tier [level1, level2, oracle]. Default: false
 
-disable_depth_maps
+disable_object_masks
 ^^^^^^^^^^^^^^^
 
 (boolean, optional)
 
-If `false`, will generate depth maps. Metadata Tier will override `disable_depth_maps`. Will only generate depth maps for Metadata tier [level1, level2, oracle]. Default: false
+If `false`, will generate object masks. Metadata Tier will override `disable_depth_maps`. Will only generate object masks for Metadata tier [level2, oracle]. Default: false
 
-disable_object_masks
+disable_position
 ^^^^^^^^^^^^^^^
 
 (boolean, optional)
 
-If `false`, will generate object masks. Metadata Tier will override `disable_depth_maps`. Will only generate object masks for Metadata tier [level2, oracle]. Default: false
+If `true`, does not generate position information output in the metadata. Metadata Tier will override `disable_position`. Default: false
 
 goal_reward
 ^^^^^^^^^^^^^^^
@@ -184,8 +184,16 @@ The `metadata` property describes what metadata will be returned by the MCS Pyth
 - `none`: Only returns the images (but no depth maps or object masks), camera info, and properties corresponding to the player themself (like head tilt). No information about specific objects will be included.
 
 If no metadata level is set:
+
 - `default`: Fallback if no metadata level is specified. Only meant for use during development (evaluations will never be run this way). Includes metadata for visible and held objects in the scene, as well as camera info and properties corresponding to the player. Does not include depth maps or object masks.
 
+only_return_goal_object
+^^^^^^^^^^^^^^^
+
+(boolean, optional)
+
+If `true`, only returns the goal object from the object list output in the metadata. Metadata Tier will override `only_return_goal_object`. Default: false
+
 steps_allowed_in_lava
 ^^^^^^^^^^^^^^^
 
@@ -228,20 +236,6 @@ step_penalty
 
 Changes the negative penalty recieved for every step. Default: 0.001
 
-timeout
-^^^^^^^
-
-(int, optional)
-
-Sets the time (in seconds) to allow on a single step before timing out. Default 3600
-
-controller_timeout
-^^^^^^^^^^^^^^^^^^
-
-(int, optional)
-
-Sets the time (in seconds) to allow on controller initialization before timing out. Default 600
-
 terminal_output
 ^^^^^^^^^^^^^^^
 
@@ -257,6 +251,13 @@ The terminal output mode controls what output metadata is logged to the terminal
 - `scene`: Prints metadata for the scene's room, including all structural objects.
 - `false` or `none`: Prints no terminal output, besides initialization, warning, and error messages.
 
+timeout
+^^^^^^^
+
+(int, optional)
+
+Sets the time (in seconds) to allow on a single step before timing out. Default 3600
+
 top_down_camera
 ^^^^^^^^^^^^^^^
 

docs/source/remotely.rst

@@ -2,8 +2,9 @@ Running Remotely
 ================
 
 Requirements:
-* Make sure your system has Python 3.7 or greater.
-* Make sure MCS has been installed per the install instructions
+
+- Make sure your system has Python 3.7 or greater.
+- Make sure MCS has been installed per the install instructions
 
 To run MCS on a remote GPU server, use the following steps to launch an X11 server.
 
@@ -23,7 +24,8 @@ To run MCS on a remote GPU server, use the following steps to launch an X11 serv
     PCI BusID : PCI:0:30:0
 
     # Create the Xserver configuration using the BusID
-    $ sudo nvidia-xconfig --use-display-device=None --virtual=600x400 --output-xconfig=/etc/X11/xorg.conf --busid=PCI:0:30:0
+    # Your virtual display size should be much larger than the MCS Unity window size (default 600x400)
+    $ sudo nvidia-xconfig --use-display-device=None --virtual=1200x800 --output-xconfig=/etc/X11/xorg.conf --busid=PCI:0:30:0
 
     # Launch Xserver
     $ sudo /usr/bin/Xorg :0 &
@@ -53,7 +55,7 @@ The following code was run on an AWS p2-xlarge with the Ubuntu Deep Learning AMI
 .. code-block:: bash
 
     # Follow the instructions listed above to launch Xserver
-    $ sudo nvidia-xconfig --use-display-device=None --virtual=600x400 --output-xconfig=/etc/X11/xorg.conf --busid=PCI:0:30:0
+    $ sudo nvidia-xconfig --use-display-device=None --virtual=1200x800 --output-xconfig=/etc/X11/xorg.conf --busid=PCI:0:30:0
     $ sudo /usr/bin/Xorg :0 &
 
     # Download the MCS repository