Welcome to LibSignal’s documentation!

Get Start

• Introduction
  • Overview of structure
• Install
  • Hands on Experience👉Colab
  • Install on your device with Source Code
    • On MacOS
    • On Linux
    • On Windows
  • Simulator environment configuration
    • CityFlow Environment
    • SUMO Environment
    • CBEngine
  • Requirment
  • Selective agents
  • selective simulation environment
• Start
  • Run Model Pipline

User Guide

• Config Settings
  • Params of Env Simulator
    • CityFlow Config File
    • SUMO Config File
  • Params of TSC Process and Agents
    • base.yml
    • FixedTime.yml
    • MaxPressure.yml
    • SOTL.yml
    • IDQN.yml
    • MAPG.yml
    • IPPO.yml
    • PressLight.yml
    • CoLight.yml
    • FRAP.yml
    • MPLight.yml
• Dataset Introduction
  • Datasets
  • Atomic Files
    • Road Network File
    • Traffic Flow File
  • Conversion Tools
• Agents
  • BaseAgent
  • RLAgent
    • Default Generator Settings
  • Imported Agent and Customized Agent
• World
  • Intersection
  • info_functions
• Generator
  • BaseGenerator
  • IntersectionPhaseGenerator
  • IntersectionVehicleGenerator
  • LaneVehicleGenerator
• Metrics
• Other Usage
  • Task and Trainer
    • Task
      • TSCTask
    • Trainer
      • TSCTrainer
  • Environment

Tutorial

• Start Experiment
  • Run Experiment with Default Setting
  • Changing Experiment Parameters
• Customize Agent
  • Create a New Agent Class
  • Implement __init__()
  • Implement reset()
  • Implement build_model()
  • Implement NewModelNet
  • Implement __repr__()
  • Implement get_ob()
  • Implement get_reward()
  • Implement get_phase()
  • Implement get_queue()
  • Implement get_delay()
  • Implement get_action()
  • Implement sample()
  • Implement remember()
  • Implement update_target_network()
  • Implement train()
  • Implement load_model()
  • Implement save_model()
  • Import The Model
  • Add Model Config
• Customize World
  • Create a New World
    • Create a New World Class
    • Implement subscribe()
    • Implement _update_infos()
    • Implement step()
    • Implement reset()
  • Create a New Intersection
    • Create a New Intersection Class
    • Implement _change_phase()
    • Implement step()
    • Implement reset()
    • Implement _get_direction()
    • Implement sort_roads()
• Customize Dataset
  • Customize Road Network File
    • CityFlow
    • SUMO
  • Customize Traffic Flow File
    • CityFlow
    • SUMO
  • Customize Configuration File
    • CityFlow
    • SUMO

API Reference

• API Introduction
  • World
    • World_cityflow module
      • Intersection
        • Intersection.insert_road()
        • Intersection.reset()
        • Intersection.sort_roads()
        • Intersection.step()
      • World
        • World.get_average_travel_time()
        • World.get_cur_phase()
        • World.get_cur_throughput()
        • World.get_executed_action()
        • World.get_history_vehicles()
        • World.get_info()
        • World.get_lane_delay()
        • World.get_lane_queue_length()
        • World.get_lane_waiting_time_count()
        • World.get_pressure()
        • World.get_vehicle_lane()
        • World.get_vehicle_trajectory()
        • World.get_vehicle_waiting_time()
        • World.reset()
        • World.reset_vehicle_info()
        • World.step()
        • World.subscribe()
        • World.update_current_measurements()
    • World_openengine module
      • Intersection
        • Intersection.observe()
        • Intersection.psedo_step()
        • Intersection.reset()
      • World
        • World.get_average_travel_time()
        • World.get_cur_phase()
        • World.get_cur_throughput()
        • World.get_info()
        • World.get_lane_delay()
        • World.get_lane_queue_length()
        • World.get_lane_vehicle_count()
        • World.get_lane_vehicles()
        • World.get_lane_waiting_time_count()
        • World.get_lane_waiting_vehicle_count()
        • World.get_pressure()
        • World.get_vehicles()
        • World.reset()
        • World.step()
        • World.subscribe()
    • World_sumo module
      • Intersection
        • Intersection.get_current_phase()
        • Intersection.observe()
        • Intersection.prep_phase()
        • Intersection.pseudo_step()
        • Intersection.reset()
      • World
        • World.generate_valid_phase()
        • World.get_average_travel_time()
        • World.get_cur_phase()
        • World.get_cur_throughput()
        • World.get_current_time()
        • World.get_info()
        • World.get_lane_delay()
        • World.get_lane_queue_length()
        • World.get_lane_vehicle_count()
        • World.get_lane_vehicles()
        • World.get_lane_waiting_time_count()
        • World.get_lane_waiting_vehicle_count()
        • World.get_plan_depart_time()
        • World.get_pressure()
        • World.get_vehicles()
        • World.reset()
        • World.step()
        • World.step_sim()
        • World.subscribe()
      • create_yellows()
  • Agent
    • base module
    • colight module
    • colight_pytorch_agent module
    • dqn module
    • dqn_torch_agent module
    • fixedtime module
    • frap module
    • frap_dqn_agent module
    • maddpg module
    • maddpg_agent module
    • maddpg_agent_util module
    • maddpg_v2 module
    • max_pressure_agent module
    • maxpressure module
    • metagenrl_agent module
    • metagenrl_model module
    • metagenrl_util module
    • mplight module
    • ppo module
    • ppo_pfrl module
    • presslight module
    • presslight_agent module
    • presslight_torch_agent module
    • rl_agent module
    • sotl module
    • tflog_utils module
    • utils module
  • Generator
    • base module
    • intersection_phase module
      • IntersectionPhaseGenerator
        • IntersectionPhaseGenerator.generate()
    • intersection_vehicle module
    • lane_vehicle module
  • Metric

Indices and tables

• Index

• Module Index

• Search Page