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

Fix docstring for log_interval to differentiate between on-policy/off-policy logging frequency #1855

Merged
merged 3 commits into from
Mar 4, 2024

Conversation

rushitnshah
Copy link
Contributor

@rushitnshah rushitnshah commented Feb 29, 2024

Description

Motivation and Context

  • The documentation describes the log_interval parameter of PPO's learn method as the "number of episodes before logging".
  • However, this description is applicable only to off-policy algorithms. Because of how PPO works logging is actually performed after every log_interval*n_steps steps of rollout collection (not log_interval episodes as the documentation describes.) (See Issue PPO log interval on Stable baselines 3. #1847)
  • This description comes from the docstring for the learn method inside base_class.py which I have updated to differentiate how log_interval is employed for on-policy v/s offpolicy.
  • 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 opened an associated PR on the SB3-Contrib repository (if necessary)
  • I have opened an associated PR on the RL-Zoo3 repository (if necessary)
  • 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
Member

@araffin araffin left a comment

Choose a reason for hiding this comment

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

LGTM, thanks =)

@araffin araffin changed the title Fix docstring for log_interval to differentiate between on-policy/off-policy logging frequency. Fix docstring for log_interval to differentiate between on-policy/off-policy logging frequency Mar 4, 2024
@araffin araffin merged commit f375cc3 into DLR-RM:master Mar 4, 2024
4 checks passed
friedeggs pushed a commit to friedeggs/stable-baselines3 that referenced this pull request Jul 22, 2024
…/off-policy logging frequency (DLR-RM#1855)

* Fix docstring for log_interval inside the learn method in the base class.

* Updated changelog.

* Update docstring

---------

Co-authored-by: Antonin RAFFIN <[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.

PPO log interval on Stable baselines 3.
2 participants