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.3.3) - Sinergym extra variables logging #412

Merged
merged 8 commits into from
May 6, 2024
Merged

Conversation

AlejandroCN7
Copy link
Member

Description

This PR enables Sinergym to log variables that are not part of the observation space. This is ideal for obtaining building information while not interfering with or complicating the learning process of DRL agents.

Motivation and Context

  • I have raised an issue to propose this change (required for new features and bug fixes)

The operating method involves having environments with all variables and then applying a wrapper that removes the desired ones from the observation space, but in such a way that their log is included. A notebook has also been created that explains the use case to use it correctly.

Fixes #410

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:

  • Created ReduceObservationWrapper in wrappers.py
  • Created tests.
  • Added wrapper documentation section.
  • Added notebook example usage section.

Extra:

  • Fix new buildings and weather documentation title nesting.

@AlejandroCN7 AlejandroCN7 merged commit 0191376 into main May 6, 2024
5 checks passed
@AlejandroCN7 AlejandroCN7 deleted the feat/issue-410 branch May 6, 2024 14:23
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.

[Feature]: Extra variables logging but without include in observation space
1 participant