Skip to main content

SustainGym: Reinforcement Learning Environments for Sustainable Energy Systems

Project description

SustainGym: Reinforcement Learning Environments for Sustainable Energy Systems

The lack of standardized benchmarks for reinforcement learning (RL) in sustainability applications has made it difficult to both track progress on specific domains and identify bottlenecks for researchers to focus their efforts on. We present SustainGym, a suite of environments designed to test the performance of RL algorithms on realistic sustainability tasks. These environments highlight challenges in introducing RL to real-world sustainability tasks, including physical constraints and distribution shift.

Paper | Website

SustainGym contains both single-agent and multi-agent RL environments.

Please see the SustainGym website for a getting started guide and complete documentation.

Folder structure

docs/                   # website and documentation
examples/               # example code for running each environment
sustaingym/             # main Python package
    algorithms/
        {env}/          # per-env algorithms
    data/
        moer/           # marginal carbon emission rates
        {env}/          # per-env data files
    envs/
        {env}/          # per-env modules
tests/                  # unit tests

Contributing

If you would like to add a new environment, propose bug fixes, or otherwise contribute to SustainGym, please see the Contributing Guide.

License

SustainGym is released under a Creative Commons Attribution 4.0 International Public License (CC BY 4.0). See the LICENSE file for the full terms.

Citation

Please cite SustainGym as

C. Yeh, V. Li, R. Datta, J. Arroyo, N. Christianson, C. Zhang, Y. Chen, M. Hosseini, A. Golmohammadi, Y. Shi, Y. Yue, and A. Wierman, "SustainGym: A Benchmark Suite of Reinforcement Learning for Sustainability Applications," in Thirty-seventh Conference on Neural Information Processing Systems Datasets and Benchmarks Track, New Orleans, LA, USA, Dec. 2023. [Online]. Available: https://openreview.net/forum?id=vZ9tA3o3hr.

BibTeX
@inproceedings{yeh2023sustaingym,
    title = {{SustainGym}: Reinforcement Learning Environments for Sustainable Energy Systems},
    author = {Yeh, Christopher and Li, Victor and Datta, Rajeev and Arroyo, Julio and Zhang, Chi and Chen, Yize and Hosseini, Mehdi and Golmohammadi, Azarang and Shi, Yuanyuan and Yue, Yisong and Wierman, Adam},
    year = 2023,
    month = 12,
    booktitle = {Thirty-seventh Conference on Neural Information Processing Systems Datasets and Benchmarks Track},
    address = {New Orleans, LA, USA},
    url = {https://openreview.net/forum?id=vZ9tA3o3hr}
}

An earlier version of this work was published as a workshop paper:

C. Yeh, V. Li, R. Datta, Y. Yue, and A. Wierman, "SustainGym: A Benchmark Suite of Reinforcement Learning for Sustainability Applications," in NeurIPS 2022 Workshop on Tackling Climate Change with Machine Learning, Dec. 2022. [Online]. Available: https://www.climatechange.ai/papers/neurips2022/38.

BibTeX
@inproceedings{yeh2022sustaingym,
    title = {{SustainGym}: A Benchmark Suite of Reinforcement Learning for Sustainability Applications},
    author = {Yeh, Christopher and Li, Victor and Datta, Rajeev and Yue, Yisong and Wierman, Adam},
    year = 2022,
    month = 12,
    booktitle = {NeurIPS 2022 Workshop on Tackling Climate Change with Machine Learning},
    address = {New Orleans, LA, USA},
    url = {https://www.climatechange.ai/papers/neurips2022/38}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sustaingym-0.1.7.tar.gz (78.4 MB view details)

Uploaded Source

Built Distribution

sustaingym-0.1.7-py3-none-any.whl (79.2 MB view details)

Uploaded Python 3

File details

Details for the file sustaingym-0.1.7.tar.gz.

File metadata

  • Download URL: sustaingym-0.1.7.tar.gz
  • Upload date:
  • Size: 78.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for sustaingym-0.1.7.tar.gz
Algorithm Hash digest
SHA256 d7cf2baa53e98cfb32cef13dfb4e192509fc71459a9637e45054fc4d305b0522
MD5 4cac4415a884d6c866ceec4cbbf21c53
BLAKE2b-256 841f5429a29883c8d67b24c341e6b2fca5d00cceebaf513b9ba63d7507d0d0ee

See more details on using hashes here.

File details

Details for the file sustaingym-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: sustaingym-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 79.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for sustaingym-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 a791cea8b3bf226056e185cf26be6aae552799325b4a8a7c876e0509ce53f0a0
MD5 aa7b0e18a709b30d9294958431b45352
BLAKE2b-256 1fff6b35da904fbba595da2219a938f3c929d079ab740312c96e435acc08b2df

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page