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 _process_sequence() docstring #219

Merged
merged 1 commit into from
Dec 5, 2023

Conversation

rogerioagjr
Copy link
Contributor

@rogerioagjr rogerioagjr commented Dec 1, 2023

Small modification in the documentation of _process_sequence to reflect the correct order (hidden_state, cell_state) of lstm_states.

See order here: https://pytorch.org/docs/stable/generated/torch.nn.LSTM.html

Description

Context

  • I have raised an issue to propose this change (required)

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)
  • The functionality/performance matches that of the source (required for new training algorithms or training-related features).
  • I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have included an example of using the feature (required for new features).
  • I have included baseline results (required for new training algorithms or training-related features).
  • I have updated the documentation accordingly.
  • I have updated the changelog accordingly (required).
  • 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

Small modification in the documentation of `_process_sequence` to reflect the correct order (`hidden_state`, `cell_state`) of `lstm_states`.

See order here: https://pytorch.org/docs/stable/generated/torch.nn.LSTM.html
@araffin araffin changed the title Update policies.py Update _process_sequence() docstring Dec 4, 2023
@araffin araffin merged commit 9f333ff into Stable-Baselines-Team:master Dec 5, 2023
4 checks passed
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