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

[RLlib] Update docstrings in recurrent encoders. #47816

Conversation

simonsays1980
Copy link
Collaborator

@simonsays1980 simonsays1980 commented Sep 25, 2024

Why are these changes needed?

Our docstrings mention that a linear output layer follows the last recurrent one. This is incorrect as we do not have a linear output layer.

This PR removes these statements from all docstrings. Instead of a linear output layer each encoder is usually followed in our default implementations by a linear layer in the corresponding heads.

Related issue number

Closes #47625. Related to #47626.

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@sven1977 sven1977 changed the title [RLlib] - Update docstrings in recurrent encoders [RLlib] Update docstrings in recurrent encoders. Sep 26, 2024
@sven1977 sven1977 marked this pull request as ready for review September 26, 2024 17:29
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.

[RLlib] - LSTM Encoder lacks the output Linear, but stated in the docstring
1 participant