Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: EEEEEclectic
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 2.65 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

Traffic Signal Control via Multi Agent Graph-based Reinforcement Learning

This repository is based on the sumo-rl framework and extended with additional functionalities to handle graph-based representations of traffic networks and apply policy learning methods such as centralised/decentralised DCRNN or transformer-based models.

Contents

Project Description

This project aims to explore and evaluate graph-based reinforcement learning methods for traffic signal control. We integrate approaches like DCRNN and transformer-based models within the SUMO-RL environment and focus on capturing spatio-temporal dependencies in the traffic network via graph structures.

Key goals: - Integrate graph-based representations to capture spatial and temporal correlation in the road network.

Repository Structure

Below is an organized overview of important scripts and directories: . sumo_rl/ # Base SUMO-RL environment code environment/ # Environment setup, traffic signal definitions models/ # Graph model class definition with utilities agents/ # Policy learning agents experiments/ centralised_dcrnn.py # Centralized DCRNN training decentralised_control.py # Decentralized Transformer-based training ... outputs/ # Collection of training results including plots and script to generate plot README.md # This README

Graph Scripts

  • sumo_rl/models/base_model.py: Base class for all models.
  • sumo_rl/models/dcrnn_cell.py: The model blocks for DCRNN model.
  • sumo_rl/models/dcrnn_model.py: The DCRNN encoder and decoder model.
  • sumo_rl/models/transformer_model.py: The graph transformer model.
  • sumo_rl/models/util.py: Collection of graph operation fucntions including graph construction, retrieving k-hop neighbors, and temporal graph preprocessing.

Policy Learning Scripts

  • sumo_rl/agents/pg_sigle_agent.py: Single agent policy learning script.
  • sumo_rl/agents/pg_multi_agent.py: Multi agent policy learning script.

Experiment and Training Scripts

  • experiments/: Training scripts to run different models.

How to Run Experiments

Prerequisites

  1. Prerequisite: Install prerequisite according to the Original SUMO-RL Documentation instruction.
  2. Libraries:
    • pytorch-geometric

Example: Training Centralized DCRNN Policy

bash python experiments/centralised_control.py

Original SUMO-RL Documentation

DOI tests PyPI version pre-commit Code style: black License

Traffic Signal Control Using Decentralised MARL via Graph

TODO: Add more to README.

SUMO-RL provides a simple interface to instantiate Reinforcement Learning (RL) environments with SUMO for Traffic Signal Control.

Goals of this repository: - Provide a simple interface to work with Reinforcement Learning for Traffic Signal Control using SUMO - Support Multiagent RL - Compatibility with gymnasium.Env and popular RL libraries such as stable-baselines3 and RLlib - Easy customisation: state and reward definitions are easily modifiable

The main class is SumoEnvironment. If instantiated with parameter 'single-agent=True', it behaves like a regular Gymnasium Env. For multiagent environments, use env or parallel_env to instantiate a PettingZoo environment with AEC or Parallel API, respectively. TrafficSignal is responsible for retrieving information and actuating on traffic lights using TraCI API.

For more details, check the documentation online.

Install

Install SUMO latest version:

bash sudo add-apt-repository ppa:sumo/stable sudo apt-get update sudo apt-get install sumo sumo-tools sumo-doc Don't forget to set SUMOHOME variable (default sumo installation path is /usr/share/sumo) ```bash echo 'export SUMOHOME="/usr/share/sumo"' >> ~/.bashrc source ~/.bashrc Important: for a huge performance boost (~8x) with Libsumo, you can declare the variable: bash export LIBSUMOASTRACI=1 ``` Notice that you will not be able to run with sumo-gui or with multiple simulations in parallel if this is active (more details).

Install SUMO-RL

Stable release version is available through pip bash pip install sumo-rl

Alternatively, you can install using the latest (unreleased) version bash git clone https://github.com/LucasAlegre/sumo-rl cd sumo-rl pip install -e .

MDP - Observations, Actions and Rewards

Observation

The default observation for each traffic signal agent is a vector: python obs = [phase_one_hot, min_green, lane_1_density,...,lane_n_density, lane_1_queue,...,lane_n_queue] - phase_one_hot is a one-hot encoded vector indicating the current active green phase - min_green is a binary variable indicating whether mingreen seconds have already passed in the current phase - ```laneidensityis the number of vehicles in incoming lane i dividided by the total capacity of the lane -lanei_queue```is the number of queued (speed below 0.1 m/s) vehicles in incoming lane i divided by the total capacity of the lane

You can define your own observation by implementing a class that inherits from ObservationFunction and passing it to the environment constructor.

Action

The action space is discrete. Every 'delta_time' seconds, each traffic signal agent can choose the next green phase configuration.

E.g.: In the 2-way single intersection there are |A| = 4 discrete actions, corresponding to the following green phase configurations:

Important: every time a phase change occurs, the next phase is preeceded by a yellow phase lasting yellow_time seconds.

Rewards

The default reward function is the change in cumulative vehicle delay:

That is, the reward is how much the total delay (sum of the waiting times of all approaching vehicles) changed in relation to the previous time-step.

You can choose a different reward function (see the ones implemented in TrafficSignal) with the parameter reward_fn in the SumoEnvironment constructor.

It is also possible to implement your own reward function:

```python def myrewardfn(trafficsignal): return trafficsignal.getaveragespeed()

env = SumoEnvironment(..., rewardfn=myreward_fn) ```

API's (Gymnasium and PettingZoo)

Gymnasium Single-Agent API

If your network only has ONE traffic light, then you can instantiate a standard Gymnasium env (see Gymnasium API): python import gymnasium as gym import sumo_rl env = gym.make('sumo-rl-v0', net_file='path_to_your_network.net.xml', route_file='path_to_your_routefile.rou.xml', out_csv_name='path_to_output.csv', use_gui=True, num_seconds=100000) obs, info = env.reset() done = False while not done: next_obs, reward, terminated, truncated, info = env.step(env.action_space.sample()) done = terminated or truncated

PettingZoo Multi-Agent API

For multi-agent environments, you can use the PettingZoo API (see Petting Zoo API):

python import sumo_rl env = sumo_rl.parallel_env(net_file='nets/RESCO/grid4x4/grid4x4.net.xml', route_file='nets/RESCO/grid4x4/grid4x4_1.rou.xml', use_gui=True, num_seconds=3600) observations = env.reset() while env.agents: actions = {agent: env.action_space(agent).sample() for agent in env.agents} # this is where you would insert your policy observations, rewards, terminations, truncations, infos = env.step(actions)

RESCO Benchmarks

In the folder nets/RESCO you can find the network and route files from RESCO (Reinforcement Learning Benchmarks for Traffic Signal Control), which was built on top of SUMO-RL. See their paper for results.

Experiments

Check experiments for examples on how to instantiate an environment and train your RL agent.

Q-learning in a one-way single intersection:

bash python experiments/ql_single-intersection.py

RLlib PPO multiagent in a 4x4 grid:

bash python experiments/ppo_4x4grid.py

stable-baselines3 DQN in a 2-way single intersection:

Obs: you need to install stable-baselines3 with pip install "stable_baselines3[extra]>=2.0.0a9" for Gymnasium compatibility. bash python experiments/dqn_2way-single-intersection.py

Plotting results:

bash python outputs/plot.py -f outputs/4x4grid/ppo_conn0_ep2

Citing

Sources used for project: ```bibtex @misc{sumorl, author = {Lucas N. Alegre}, title = {{SUMO-RL}}, year = {2019}, publisher = {GitHub}, journal = {GitHub repository}, howpublished = {\url{https://github.com/LucasAlegre/sumo-rl}}, }

@inproceedings{li2018dcrnn_traffic, title={Diffusion Convolutional Recurrent Neural Network: Data-Driven Traffic Forecasting}, author={Li, Yaguang and Yu, Rose and Shahabi, Cyrus and Liu, Yan}, booktitle={International Conference on Learning Representations (ICLR '18)}, year={2018} } ```

Owner

  • Login: EEEEEclectic
  • Kind: user

GitHub Events

Total
  • Watch event: 9
  • Delete event: 1
  • Push event: 79
  • Public event: 1
  • Pull request event: 2
  • Fork event: 4
  • Create event: 3
Last Year
  • Watch event: 9
  • Delete event: 1
  • Push event: 79
  • Public event: 1
  • Pull request event: 2
  • Fork event: 4
  • Create event: 3

Dependencies

.github/workflows/build-publish.yml actions
  • actions/checkout v3 composite
  • actions/download-artifact v4.1.7 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/deploy-docs.yml actions
  • JamesIves/github-pages-deploy-action v4 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/linux-test.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/pre-commit.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
docs/requirements.txt pypi
  • furo *
  • myst-parser *
  • sphinx *
pyproject.toml pypi
  • gymnasium >=0.26
  • numpy *
  • pandas *
  • pettingzoo >=1.22.2
  • pillow *
  • sumolib >=1.14.0
  • traci >=1.14.0
requirements.txt pypi
  • ipykernel *
  • jupyter *
  • numpy *
setup.py pypi
Dockerfile docker
  • ubuntu 20.04 build
environment.yml pypi
  • cloudpickle ==3.1.0
  • farama-notifications ==0.0.4
  • gymnasium ==1.0.0
  • numpy ==2.1.3
  • pandas ==2.2.3
  • pettingzoo ==1.24.3
  • pillow ==11.0.0
  • python-dateutil ==2.9.0.post0
  • pytz ==2024.2
  • sumo-rl ==1.4.5
  • sumolib ==1.21.0
  • traci ==1.21.0
  • typing-extensions ==4.12.2
  • tzdata ==2024.2