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

Separate README.md installation section and add a list of tools which are using Sinergym #333

Merged
merged 13 commits into from
Apr 27, 2023

Conversation

AlejandroCN7
Copy link
Member

@AlejandroCN7 AlejandroCN7 commented Apr 26, 2023

Description

README.md is too long, so Installation section is separated and referenced in README.md. A list of tools which are using Sinergym is added too. The idea is for the other projects to do a PR on that list.

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 #(issue or issues)

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:

  • Separate installation section from README.md.
  • WandB feature updated instead of MLFlow and Tensorboard in README.md.
  • Added project list using Sinergym in README.md.
  • Update web documentation too.
  • Deleted mlflowbuild script from repository root.

…ature added instead of MLFlow and Tensorboard in README.md
@AlejandroCN7 AlejandroCN7 added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 26, 2023
@AlejandroCN7 AlejandroCN7 self-assigned this Apr 26, 2023
@AlejandroCN7 AlejandroCN7 marked this pull request as ready for review April 27, 2023 09:32
@AlejandroCN7 AlejandroCN7 merged commit 42b6e6e into main Apr 27, 2023
@AlejandroCN7 AlejandroCN7 deleted the update-readme branch April 27, 2023 09:33
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants