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

Migration Guide #123

Merged
merged 25 commits into from
Oct 11, 2020
Merged

Migration Guide #123

merged 25 commits into from
Oct 11, 2020

Conversation

araffin
Copy link
Member

@araffin araffin commented Jul 25, 2020

Description

This is a first draft of the migration guide. Most of the content is there but it should be probably refined in a follow-up PR before v1.0 release.

Motivation and Context

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

closes #11

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)

Checklist:

  • I've read the CONTRIBUTION guide (required)
  • I have updated the changelog accordingly (required).
  • My change requires a change to the documentation.
  • I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have updated the documentation accordingly.
  • I have reformatted the code using make format (required)
  • I have checked the codestyle using make check-codestyle and make lint (required)
  • I have ensured make pytest and make type both pass. (required)

Note: we are using a maximum length of 127 characters per line

@araffin araffin mentioned this pull request Sep 24, 2020
9 tasks
@araffin araffin marked this pull request as ready for review October 7, 2020 08:58
@Miffyli
Copy link
Collaborator

Miffyli commented Oct 11, 2020

Just two more comments I could see. After addressing those I think this is good to go finally!

Copy link
Collaborator

@Miffyli Miffyli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If no more changes coming, LGTM!

@araffin araffin merged commit fc6c5d3 into master Oct 11, 2020
@araffin araffin deleted the doc/migration branch October 11, 2020 21:22
leor-c pushed a commit to leor-c/stable-baselines3 that referenced this pull request Nov 12, 2020
* Start migration guide

* Update guide

* Add comment on RMSpropTFLike plus PPO/A2C migrations

* Add note about set/get-parameters

* Update migration guide

* Update changelog and readme

* Update doc + clean changelog

* Address comments

Co-authored-by: Anssi "Miffyli" Kanervisto <[email protected]>
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.

Migration guide
2 participants