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

Update doc: SB3-Contrib #267

Merged
merged 8 commits into from
Dec 21, 2020
Merged

Update doc: SB3-Contrib #267

merged 8 commits into from
Dec 21, 2020

Conversation

araffin
Copy link
Member

@araffin araffin commented Dec 21, 2020

Description

Update doc to mention sb3-contrib and update internal variable names to match the one discussed in Stable-Baselines-Team/stable-baselines3-contrib#13.
I also fixed a minor bug when saving DQN q-network alone.

Motivation and Context

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

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)
  • I have checked that the documentation builds using make doc (required)

Note: You can run most of the checks using make commit-checks.

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

Copy link
Collaborator

@AdamGleave AdamGleave left a comment

Choose a reason for hiding this comment

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

Few wording changes and one question about test parameter, otherwise LGTM

docs/guide/sb3_contrib.rst Outdated Show resolved Hide resolved
docs/guide/sb3_contrib.rst Outdated Show resolved Hide resolved
docs/guide/sb3_contrib.rst Outdated Show resolved Hide resolved
docs/guide/sb3_contrib.rst Outdated Show resolved Hide resolved
@@ -408,6 +408,82 @@ def test_save_load_policy(tmp_path, model_class, policy_str):
os.remove(tmp_path / "actor.pkl")


@pytest.mark.parametrize("model_class", [DQN])
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why do we have this as a parameter when we only set it to one value? Upgrade potential?

Copy link
Member Author

Choose a reason for hiding this comment

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

hmm, I wrote that test when I found the bug reviewing QR-DQN PR on the contrib repo.
So, I think my idea was that QR-DQN will be part of SB3 main repo at some point, hence the parameter ;).

araffin and others added 2 commits December 21, 2020 15:22
Co-authored-by: Adam Gleave <adam@gleave.me>
@araffin
Copy link
Member Author

araffin commented Dec 21, 2020

Few wording changes and one question about test parameter, otherwise LGTM

thanks for the suggestions =) (I will update SB3 contrib readme too afterward)

Copy link
Collaborator

@AdamGleave AdamGleave left a comment

Choose a reason for hiding this comment

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

LGTM

@araffin araffin merged commit 944dfda into master Dec 21, 2020
@araffin araffin deleted the doc/sb3-contrib branch December 21, 2020 15:17
liuyuqi123 added a commit to liuyuqi123/stable-baselines3 that referenced this pull request Dec 29, 2020
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.

2 participants