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.5.10) - Sinergym terminal logging level set and intallation section documentation fix #444

Merged
merged 9 commits into from
Sep 17, 2024

Conversation

AlejandroCN7
Copy link
Member

Description

This new version has been developed to meet the specifications of the referenced issue. The constants that set the logging levels for each module are still used as default values when importing Sinergym. However, these can be modified from the package once the environment has been created to update the logging levels in real time via the terminal.

Documentation and a notebook with a use case have been prepared.

Additionally, the installation section has been updated with some minor corrections.

Motivation and Context

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

Fixes #432

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:

  • Update MODELING layer to MODEL in loggers name.
  • Develop sinergym package function to update loggers level.
  • Logger: Develop simple logger for environment prints.
  • Environment: Updated prints with developed simple logger.
  • Set logger levels fix: wrapper loggers managed as set.
  • Documentation: Added sinergym update logger level example in notebooks, and update documentation reference.
  • Fix installation section in documentation.

@AlejandroCN7 AlejandroCN7 merged commit 745b8df into main Sep 17, 2024
4 checks passed
@AlejandroCN7 AlejandroCN7 deleted the feat/issue-432 branch September 17, 2024 14:14
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]: Verbose option in Sinergym environments (terminal logger)
1 participant