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.0.6) - Sinergym Callbacks fix in SB3 evaluation and logs #363

Merged
merged 17 commits into from
Sep 15, 2023

Conversation

AlejandroCN7
Copy link
Member

@AlejandroCN7 AlejandroCN7 commented Sep 13, 2023

Description

This minor update try to improve the Sinergym callbacks for SB3 evaluations and logs. Logging is now more flexible and uniform. Sinergym was sensitive to the class of SB3 algorithm used for the record of the metrics. With this patch, Sinergym can fix the dump frequency of the data and not depend on the algorithm type (On or Off Policy basically).

Motivation and Context

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

Why is this change required? What problem does it solve? Please, reference issue or issues opened previously.

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:

  • Improved LoggerCallback, new argument called dump_frequency added, and it is uniform for all algorithms.
  • Fixed comfort violation condition during training.
  • Improved some Sinergym logger names (in SB3 algorithms and its local logger).
  • Added new metrics in evaluation logs.
  • Improved code for loggers.
  • Fixed some attributes get with new gymnasium protocol (v3.0.5)
  • Updated env attribute name experiment_path to workspace_path.
  • Updated documentation and tests.
  • Updated notebooks outputs

@AlejandroCN7 AlejandroCN7 marked this pull request as ready for review September 15, 2023 16:35
@AlejandroCN7 AlejandroCN7 merged commit 8b35fd4 into main Sep 15, 2023
5 checks passed
@AlejandroCN7 AlejandroCN7 deleted the minor-update branch September 15, 2023 16:39
@AlejandroCN7 AlejandroCN7 added enhancement New feature or request callback Sinergym callbacks log New information that should be recordered labels Nov 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
callback Sinergym callbacks enhancement New feature or request log New information that should be recordered
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant