Document LSTMCell carry as the (c, h) tuple it actually is#5469
Open
adityasingh2400 wants to merge 1 commit into
Open
Document LSTMCell carry as the (c, h) tuple it actually is#5469adityasingh2400 wants to merge 1 commit into
adityasingh2400 wants to merge 1 commit into
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
The LSTMCell.__call__ docstring described 'carry' as 'the hidden state of the LSTM cell', leaving users to infer that it is actually a tuple of cell state and hidden state both of shape (*batch, features), typically created via LSTMCell.initialize_carry. Spell that contract out in both the Linen and NNX twins, and mirror the same docstring for OptimizedLSTMCell. Fixes google#4124
b63a4cd to
386bf30
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
LSTMCell.__call__docstring describedcarryonly as "the hidden state of the LSTM cell", which is misleading:carryis actually a tuple(c, h)of the cell state and the hidden state, asinitialize_carryand the implementation both make clear (return (c, h)andc, h = carry).This PR spells out the contract in the docstring:
Applied to all four affected
__call__docstrings for parity:flax/linen/recurrent.pyLSTMCellflax/linen/recurrent.pyOptimizedLSTMCellflax/nnx/nn/recurrent.pyLSTMCellflax/nnx/nn/recurrent.pyOptimizedLSTMCellThe
OptimizedLSTMCelldocstrings previously pointed atLSTMCell.initialize_carry; those references are also updated toOptimizedLSTMCell.initialize_carryto match the class users actually have a handle to.Fixes #4124.
Test plan
c, h = carry,return (new_c, new_h), new_h) andinitialize_carryshapes.