Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(v3.6.5) - Functionalities to take energy costs into account. #454

Merged
merged 12 commits into from
Nov 8, 2024

Conversation

fpertinezp
Copy link
Contributor

Description

These changes allow the addition of the energy cost term both in the calculation of the reward function and in the observation of the environment.

Motivation and Context

Incorporating energy cost into the reward function and environment observation enhances the agent's ability to balance performance with energy efficiency, which is vital for minimizing operational costs and environmental impact.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Improvement (of an existing feature)
  • Others

Checklist:

  • I've read the CONTRIBUTION guide (required)
  • My change requires a change to the documentation.
  • I have updated the tests.
  • I have updated the documentation accordingly.
  • I have reformatted the code using autopep8 second level aggressive.
  • I have reformatted the code using isort.
  • I have ensured cd docs && make spelling && make html pass (required if documentation has been updated.)
  • I have ensured pytest tests/ -vv pass. (required).
  • I have ensured pytype -d import-error sinergym/ pass. (required)

Changelog:

  • sinergym/utils/rewards.py: Implementation of EnergyCostLinearReward.
  • sinergym/utils/wrappers.py: Implementation of EnergyCostWrapper.
  • sinergym/data/energy_cost/example.csv: Added example file with energy cost data.
  • tests/(conftest.py, test_reward.py and test_wrapper): Implementation of unit test for the new functionalities.
  • docs/source/pages/(rewards.rst, wrappers.rst and spelling_wordlist.txt): Update of documentation.
  • pyproject.toml and sinergym/version.txt: Sinergym version updated.

@AlejandroCN7 AlejandroCN7 merged commit 4ea8376 into ugr-sail:main Nov 8, 2024
6 checks passed
@AlejandroCN7 AlejandroCN7 mentioned this pull request Nov 14, 2024
15 tasks
@fpertinezp fpertinezp deleted the feat/reward-function branch November 15, 2024 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants