sustaingym
Reinforcement Learning Environments for Sustainable Energy Systems
Science Score: 13.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
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary
Keywords
Repository
Reinforcement Learning Environments for Sustainable Energy Systems
Basic Info
- Host: GitHub
- Owner: chrisyeh96
- License: cc-by-4.0
- Language: HTML
- Default Branch: main
- Homepage: https://chrisyeh96.github.io/sustaingym/
- Size: 132 MB
Statistics
- Stars: 54
- Watchers: 5
- Forks: 13
- Open Issues: 3
- Releases: 3
Topics
Metadata Files
README.md
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.
SustainGym contains both single-agent and multi-agent RL environments. - Single-agent environments follow the Gymnasium API and are designed to be easily used with the StableBaselines3 and Ray RLLib libraries for training RL algorithms. - Multi-agent environments follow the PettingZoo Parallel API and are designed to be easily used with the Ray RLLib library for training multi-agent RL algorithms.
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
```tex @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
```tex @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} } ```Owner
- Name: Christopher Yeh
- Login: chrisyeh96
- Kind: user
- Repositories: 11
- Profile: https://github.com/chrisyeh96
GitHub Events
Total
- Watch event: 14
- Push event: 2
- Fork event: 3
Last Year
- Watch event: 14
- Push event: 2
- Fork event: 3
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Christopher Yeh | c****6 | 69 |
| Ethan Wilk | e****k@g****m | 17 |
| Chi Zhang | 9****6 | 2 |
| liv20 | 5****0 | 1 |
| Nico Christianson | n****n@g****m | 1 |
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 1
- Total pull requests: 27
- Average time to close issues: N/A
- Average time to close pull requests: about 1 month
- Total issue authors: 1
- Total pull request authors: 7
- Average comments per issue: 0.0
- Average comments per pull request: 0.26
- Merged pull requests: 18
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- Swathii-CP (1)
Pull Request Authors
- chrisyeh96 (8)
- chz056 (6)
- ewilk0 (5)
- rajeev-datta (3)
- liv20 (3)
- chennnnnyize (1)
- nhchristianson (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 13 last-month
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 13
- Total maintainers: 1
proxy.golang.org: github.com/chrisyeh96/sustaingym
- Documentation: https://pkg.go.dev/github.com/chrisyeh96/sustaingym#section-documentation
- License: cc-by-4.0
-
Latest release: v0.1.7
published over 1 year ago
Rankings
pypi.org: sustaingym
SustainGym: Reinforcement Learning Environments for Sustainable Energy Systems
- Homepage: https://chrisyeh96.github.io/sustaingym/
- Documentation: https://sustaingym.readthedocs.io/
- License: CC BY 4.0
-
Latest release: 0.1.7
published over 1 year ago