Documentation for the Dim object #232
Merged
Conversation
This file contains 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
|
This is great, but I agree it probably shouldn't be in mini-batching. I'm going to be writing some text on DyNet's programming paradigm shortly, so maybe we can move it to the doc as well when it's finished. |
|
OK I removed it from the sphinx source for now. It can now be merged, at least the code is somewhat documented |
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.
For now I've put it in the minibatching part of the documentation. Not sure if this is the best place.
One remark : I'm not too sure of what the "truncate" function achieves so if someone knows... I left it as a TODO for now.
On a related note I think there should be a "Core Dynet" section in the docs with documentation for the computation graph and other core classes like parameters and such. I'll look into it but if someone with more experience in the internals wants to start, go ahead.