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

New Documentation structure and some changes (v1.8.0) #193

Merged
merged 26 commits into from
Mar 28, 2022
Merged

Conversation

AlejandroCN7
Copy link
Member

@AlejandroCN7 AlejandroCN7 commented Mar 24, 2022

Description

In this update, I am going to focus on modifying the documentation to make it more user-friendly. At the same time, I resolve some small issues that we have pending

Motivation and Context

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

Fixes #192
Fixes #191
Fixes #166
Fixes #194

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)
  • 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:

  • Added try_env.py to workspace in Dockerfile.
  • Deleted default parameter for dictionary in Normalize wrapper and add that dictionary specification to load_model.py.
  • Added conda environment file to configure automatically with python 3.9 version and Sinergym module (and pip dependencies).
  • Fix datacenter-cool-X environments name in Sinergym register.
  • Re-estructure documentation order, installation explanation re-estructured too, added config tests, more examples about how to use Sinergym.
  • Added year field to Sinergym in order to define runperiods.
  • Added runperiod extra_parameter (changes in common, controller, wrappers, rewards, eplus_env in order to adapt it to new year field in environmets).
  • New documentation in extra configuration.
  • README.md synchronized with the Sinergym documentation.
  • Tests adapted to new version.

@AlejandroCN7 AlejandroCN7 added documentation Improvements or additions to documentation enhancement New feature or request wrapper Everything related to wrappers labels Mar 24, 2022
@AlejandroCN7 AlejandroCN7 marked this pull request as ready for review March 28, 2022 14:09
@AlejandroCN7 AlejandroCN7 merged commit 9bc3925 into main Mar 28, 2022
@AlejandroCN7 AlejandroCN7 deleted the doc/issue-166 branch March 28, 2022 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request wrapper Everything related to wrappers
Projects
None yet
1 participant