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.

Sign up for GitHub

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

Jump to bottom

Update documentation #199

Merged
merged 14 commits into from
Oct 28, 2020
Merged

Update documentation #199

merged 14 commits into from
Oct 28, 2020

Conversation

araffin
Copy link
Member

@araffin araffin commented Oct 23, 2020 •
edited
Loading

Description

closes #7
closes #166

Missing:

NOTE: in the get/set parameters, I used PyTorch native methods, as it was easier and cleaner.

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)

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

@araffin araffin changed the title Update doc Update documentation Oct 24, 2020
@araffin araffin marked this pull request as ready for review October 25, 2020 11:46
@araffin araffin requested a review from Miffyli October 25, 2020 11:46
Miffyli
Miffyli reviewed Oct 27, 2020
View reviewed changes
docs/guide/examples.rst Outdated Show resolved Hide resolved
Miffyli
Miffyli reviewed Oct 27, 2020
View reviewed changes
docs/guide/examples.rst Outdated Show resolved Hide resolved
Miffyli
Miffyli reviewed Oct 27, 2020
View reviewed changes
docs/guide/export.rst Outdated Show resolved Hide resolved
Miffyli
Miffyli reviewed Oct 27, 2020
View reviewed changes
docs/guide/export.rst Outdated Show resolved Hide resolved
@Miffyli
Copy link
Collaborator

Miffyli commented Oct 27, 2020

Left some minor comments but mostly looks good :). With this amount of text I would run modifications through grammar-check just to be on the safe-side.

@araffin
Copy link
Member Author

araffin commented Oct 27, 2020

Left some minor comments but mostly looks good :). With this amount of text I would run modifications through grammar-check just to be on the safe-side.

Thanks for the comments =)
I ran the spell-check already... Do you have a good to recommend for grammar-check?

@Miffyli
Copy link
Collaborator

Miffyli commented Oct 27, 2020

I ran the spell-check already... Do you have a good to recommend for grammar-check?

Not really, I just personally copy-paste things to Word or GDocs :'D . Should probably invest in "proper" tools.

@Miffyli
Copy link
Collaborator

Miffyli commented Oct 28, 2020

Ran text through GDocs for crude grammar check. From my side this is good to go, feel free to approve and merge if you agree with the changes :)

@araffin araffin merged commit 897e98c into master Oct 28, 2020
@araffin araffin deleted the doc/additional-doc branch October 28, 2020 08:55
leor-c pushed a commit to leor-c/stable-baselines3 that referenced this pull request Nov 12, 2020
@araffin @Miffyli @leor-c
Update documentation (DLR-RM#199)
014652a 
* Update doc and add new example

* Add save/load replay buffer example

* Add save format + export doc

* Add example for get/set parameters

* Typos and minor edits

* Add results sections

* Add note about performance

* Add DDPG results

* Address comments

* Fix grammar/wording

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
Reviewers

@Miffyli Miffyli Miffyli left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Missing Documentation Update colab notebooks
2 participants
@araffin @Miffyli