stable-baselines3 icon indicating copy to clipboard operation
stable-baselines3 copied to clipboard

Add capability to log on a step-based interval in OffPolicyAlgorithm

Open tobiabir opened this issue 2 years ago • 0 comments

Description

  • Removed log_interval argument from collect_rollouts in OffPolicyAlgorithm
  • Added logging in learn of OffPolicyAlgorithm instead
  • Fixed documentation of the functionality of log_interval
  • Swapped logging and training in learn for both OffPolicyAlgorithm and OnPolicyAlgorithm
  • Updated default values for log_interval for off-policy algorithms
  • Updated changelog

Motivation and Context

  • [x] I have raised an issue to propose this change (required for new features and bug fixes) Closes #1708

Types of changes

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [x] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)
  • [x] Documentation (update in the documentation)

Checklist

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

tobiabir avatar Oct 06 '23 12:10 tobiabir