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.1.8) Sinergym truncated flag update #386

Merged
merged 6 commits into from
Feb 6, 2024
Merged

Conversation

AlejandroCN7
Copy link
Member

Description

This patch causes Sinergym to use the truncated flag instead of terminated when the episode has been completed naturally without any event causing it to be forcibly terminated. For more information, visit the referenced issue.

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.

Fixes #384

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:

  • Adapting the truncated flag updated in Sinergym environment layer.
  • Updated all examples and script to use truncated and terminated to do a reset automatically.
  • Sinergym loggers (CSVLogger class and wrapper) log truncated flag in monitor.csv too.
  • Updated tests.

@AlejandroCN7 AlejandroCN7 merged commit 6f66a1e into main Feb 6, 2024
5 checks passed
@AlejandroCN7 AlejandroCN7 deleted the impr/issue-384 branch February 6, 2024 15:30
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.

[Enhancement]: terminated and truncated flag, correct use.
1 participant