Rlglue gridworld

README.md

@@ -1,59 +1,43 @@
 # RLtoolkit
-RLtoolkit   Version 1.0 b7  October 27, 2017
+Version 2.0 b0 August 17, 2018
 
-Note: the arrangement of modules in this package is subject to change (and most likely will!) with future releases.
 
-
-##To use:
-1. Move the RLtoolkit folder to your site-packages folder for Python
+## To use:
+1. Recommended: `python3 -m pip install git+https://github.com/AmiiThinks/rltoolkit.git`
+
+   Alternate:
+   Move the RLtoolkit folder to your site-packages folder for Python
                                OR
    `export PYTHONPATH=$PYTHONPATH:/path/to/rltoolkit`
 
 2. You can then import as you would any other package
 
     In Python:
-        from RLtoolkit import Tiles.tiles as tiles
-            from RLtoolkit.traces import *
-            from RLtoolkit import *
-            etc.
+    ```pythonstub
+    from RLtoolkit import tiles3.tiles as tiles
+    from RLtoolkit.rl_glue import RLGlue
+    etc.
+    ```
     From the command line:
-        python -m RLtoolkit.gridworld.gwDemoG
-
+    ```pythonstub
+    python -m RLtoolkit.examples.mountain_car_gui.py
+    ```
+
+
+## Contents:
+
+- **examples** - a folder of demos to run, using the toolkit
+  - mountain car (GUI)
+  - random walk (text-based)
+  - gridworld (GUI)
+  - gridworld (text-based)
+- **gridworld** - gridworld code, including a demo
+- **G** - a general low level graphics drawing package
+- **Quickgraph** - a simple graphing package (uses g) for 2 and 3d graphs
+
+- **rl_glue** - main interface for connecting agents and environments
+- **utilities** - some general utilities
+- **glue_guiwindow** - a generic simulation window with buttons and menus
+   (not yet documented for users, uses RL-Glue)
+- **tiles3** - the tile coding package from http://www.incompleteideas.net/tiles/tiles3.html
 
-##Contents:
-
-examples - a folder of demos to run, using the toolkit
-  - the maintenance example
-  - mountain car (GUI and nonGUI)
-
-fa - function approximation demo
-   (currently only uses tile coding)
-gridworld - gridworld demo
-G - a general low level graphics drawing package
-Quickgraph - a simple graphing package (uses g) for 2 and 3d graphs
-Tiles - the tile coding package
-
-basicclasses.py - definitions for simulation, agent and environment objects
-RLinterface - contains the rl interface object and methods for it
-traces - eligibility traces handling
-utilities - some general utilities
-guiwindow - a generic simulation window with buttons and menus
-   (not yet documented for users)
-demo - helps load the demos and run them
-guiuser - loads all the major tools from the toolkit
-  (if you do from guiuser import *, you get all the tools with no need to
-   prefix module names)
-
-These are shortcuts to some of the tool packages:
-tiles - imports Tiles.tiles
-g.py - imports G.g
-graph.py - imports Quickgraph.graph
-graph3d.py - imports Quickgraph.graph3d
-
-There are some extra things for the RLinterface:
-RLinterface2 is the interface described on the first RLAI web page as RL 6
-RLinterface3 is a start of the interface described on the RL benchmarks page
-rlitest2a is a simple test of RLinterface2
-rlitest2b is the random walk example with RLinterface2
-rlittest3a is a simple test of RLinterface3
-rlitest3b is the random walk example with RLinterface3