Merge branch 'master' of https://github.com/flow-project/flow into improve-tutorials

Author: nathanlct

.travis.yml

@@ -15,6 +15,13 @@ git:
   depth: 1
 
 before_install:
+  # install and run pep8 and docstyle tests
+  - pip install pydocstyle
+  - pydocstyle --convention numpy
+  - pip install flake8 .
+  - flake8 --version
+  - flake8 --show-source
+
   # Setup conda (needed for opencv, ray dependency)
   - wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
   - bash miniconda.sh -b -p $HOME/miniconda
@@ -41,17 +48,10 @@ before_install:
   - ls ../
 
 install:
-  - pip install flake8 .
   - pip install coveralls
   - pip install nose
   - pip install matplotlib
   - pip install jupyter
-  - pip install pydocstyle
-
-before_script:
-  - flake8 --version
-  - flake8 --show-source
-  - pydocstyle --convention numpy
 
 script:
   - python setup.py install

README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://travis-ci.com/flow-project/flow.svg?branch=master)](https://travis-ci.com/flow-project/flow)
 [![Docs](https://readthedocs.org/projects/flow/badge)](http://flow.readthedocs.org/en/latest/)
 [![Coverage Status](https://coveralls.io/repos/github/flow-project/flow/badge.svg?branch=master)](https://coveralls.io/github/flow-project/flow?branch=master)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/flow-project/flow/binder)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/flow-project/flow/blob/master/LICENSE.md)
 
 # Flow
@@ -16,6 +17,7 @@ See [our website](https://flow-project.github.io/) for more information on the a
 - [Documentation](https://flow.readthedocs.org/en/latest/)
 - [Installation instructions](http://flow.readthedocs.io/en/latest/flow_setup.html)
 - [Tutorials](https://github.com/flow-project/flow/tree/master/tutorials)
+- [Binder Build (beta)](https://mybinder.org/v2/gh/flow-project/flow/binder)
 
 # Technical questions
 

docs/source/multiagent.rst

@@ -13,15 +13,20 @@ The keys of the dictionary are IDs of the agent policies.
 
 **Note that you must also subclass MultiEnv.**
 
-A brief example of a multiagent env:
+A brief example of a multiagent environment:
 ::
 
     from flow.envs.multiagent_env import MultiEnv
 
     class MultiAgentAccelEnv(AccelEnv, MultiEnv):
-        """Example MultiAgent environment"""
+        """Example multiagent environment"""
 
         def _apply_rl_actions(self, rl_actions):
+            """
+            Apply individual agent actions.
+
+            :param rl_actions: dictionary of format {agent_id : action vector}.
+            """
             rl_ids = []
             rl_action_list = []
             for rl_id, action in rl_actions.items():
@@ -30,20 +35,19 @@ A brief example of a multiagent env:
             self.k.vehicle.apply_acceleration(rl_ids, rl_action_list)
 
         def compute_reward(self, rl_actions, **kwargs):
-            """In this example all agents receive a reward of 10"""
+            """In this example, all agents receive a reward of 10"""
             reward_dict = {}
             for rl_id, action in rl_actions.items():
                 reward_dict[rl_id] = 10
             return reward_dict
 
         def get_state(self, **kwargs):
-            """Here every agent gets its speed"""
-            # speed normalizer
+            """Every agent observes its own speed"""
             obs_dict = {}
             for rl_id in self.k.vehicle.get_rl_ids():
                 obs_dict[rl_id] = self.k.vehicle.get_speed(rl_id)
             return obs_dict
 
 
 For further details look at our
-`Multiagent examples <https://github.com/flow-project/flow/tree/master/examples/rllib/multiagent_exps>`_.
+`multiagent examples <https://github.com/flow-project/flow/tree/master/examples/rllib/multiagent_exps>`_.

examples/rllab/stabilizing_the_ring.py

@@ -8,7 +8,7 @@
 
 from flow.scenarios.loop import LoopScenario
 from flow.controllers import RLController, IDMController, ContinuousRouter
-from flow.core.params import VehicleParams
+from flow.core.params import VehicleParams, SumoCarFollowingParams
 from flow.core.params import SumoParams, EnvParams, NetParams, InitialConfig
 from rllab.envs.gym_env import GymEnv
 
@@ -28,6 +28,9 @@ def run_task(*_):
     vehicles.add(
         veh_id="idm",
         acceleration_controller=(IDMController, {}),
+        car_following_params=SumoCarFollowingParams(
+            min_gap=0,
+        ),
         routing_controller=(ContinuousRouter, {}),
         num_vehicles=21)