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.

Sign up for GitHub

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

Jump to bottom

Add better docs for the LSTM function #1696

Closed
logankilpatrick opened this issue Aug 22, 2021 · 1 comment
Closed

Add better docs for the LSTM function #1696

logankilpatrick opened this issue Aug 22, 2021 · 1 comment
Labels
documentation

Comments

@logankilpatrick
Copy link
Member

Along the lines as this question: https://stackoverflow.com/questions/68885126/how-to-make-use-lstms-in-flux-jl it would be great to update the docs to specific what the two input variables actually relate to when creating an LSTM. Same thing goes for RNN and GRU. IMO, the docs for those should have enough substance to stand on their own.
@mcognetta mcognetta mentioned this issue Nov 21, 2021
Merged
bors bot added a commit that referenced this issue Nov 23, 2021
@bors @mcognetta
Merge #1772
66a84ef 
1772: Expand RNN/LSTM/GRU docs r=ToucheSir a=mcognetta

This PR adds expanded documentation to the RNN/LSTM/GRU/GRUv3 docs, resolving #1696.

It addresses the `in` and `out` parameter meanings and adds a warning about a common gotcha (not calling reset when batch sizes are changed).

Co-authored-by: Marco Cognetta <[email protected]>
@logankilpatrick
Copy link
Member Author

Thank you @mcognetta !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@logankilpatrick