Skip to content

Migration Guide#123

Merged
araffin merged 25 commits into
masterfrom
doc/migration
Oct 11, 2020
Merged

Migration Guide#123
araffin merged 25 commits into
masterfrom
doc/migration

Conversation

@araffin

@araffin araffin commented Jul 25, 2020

Copy link
Copy Markdown
Member

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
Comment thread docs/guide/migration.rst Outdated
Comment thread docs/guide/migration.rst Outdated
Comment thread docs/guide/migration.rst Outdated
Comment thread docs/guide/migration.rst Outdated
Comment thread docs/guide/migration.rst Outdated
Comment thread docs/guide/migration.rst Outdated
Comment thread docs/guide/migration.rst Outdated
Comment thread docs/guide/migration.rst Outdated
@Miffyli

Miffyli commented Oct 11, 2020

Copy link
Copy Markdown
Collaborator

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

@Miffyli Miffyli left a comment

Copy link
Copy Markdown
Collaborator

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 <kaneran21@hotmail.com>
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