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

Expand How Does it Work section #13

Open
nicholas-leonard opened this issue Jun 21, 2016 · 3 comments
Open

Expand How Does it Work section #13

nicholas-leonard opened this issue Jun 21, 2016 · 3 comments

Comments

@nicholas-leonard
Copy link

Could you guys expand on the how does it work section in the docs? Specifying how the output, gradInput, weight, gradWeight and intermediate state buffers are handled would be a plus.

@fmassa
Copy link
Owner

fmassa commented Jun 21, 2016

Sure, I'll improve the README with more information about it, thanks for mentioning it Nicholas !
I'll find some time this week to do it.

@geert56
Copy link

geert56 commented Aug 29, 2016

I would love to see some more algorithm documentation: what is the approach you take, what do the main functions do, what are the assumptions in terms of existing Torch data structures. It would greatly help others in improving and extending the code. Thanks.

@fmassa
Copy link
Owner

fmassa commented Sep 1, 2016

Hi @geert56,
I have prepared some initial version of a more complete documentation in #16 .
I didn't add much more since then because I have been quite busy over the past few months, but let me know what else you'd like to see in the documentation and I'll try to add it when I have time (probably in October).

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

No branches or pull requests

3 participants