This repository has been archived by the owner on Nov 17, 2023. It is now read-only.
Fix docs for some NDArray functions #5808
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
Roshrini
force-pushed
the
api-docs
branch
3 times, most recently
from
8c4a734 to
c36ac6f
Compare
zackchase
reviewed
Apr 14, 2017
src/operator/sequence_mask.cc
Outdated
| ) | ||
| .describe(R"code(Sets all elements outside the sequence to a constant value. | ||
|
|
||
| This function takes an n-dimensional input array of the form [max sequence length, batch size, other dims] |
There was a problem hiding this comment.
maybe better to indicate some how that "max sequence length" refers to a single quantity (it does, correct?). I suggest just using underscores:
[max_sequence_length, batch_size, other dims]
Now for "other dims" -- what does that mean? it's not obvious form the context.
There was a problem hiding this comment.
Used underscore for parameters. other_dims here means extra feature dimensions which doesn't matter for these sequence* functions. I changed it to other_feature_dims now. Is it fine?
Guneet-Dhillon
pushed a commit
to Guneet-Dhillon/mxnet
that referenced
this pull request
Sep 13, 2017
* sort,argsort,topk,argmin,argmax,argmax_channel docs modified * some sentence structure changes * revert some changes made * minor change * sentence restructering * sequencelast modified * minor word changes * formatting fixes * SequenceMask added * docs for SequenceReverse,true_divide is added * line break * minor change * take, batch_take operators added * minor formatting changes * Changes after review * note modified
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Modified docs for functions sort, argsort, argmin, argmax, argmax_channel, sequenceLast, SequenceMask, SequenceReverse, true_divide, take, batch_take.
@mli, @zackchase, @nswamy @madjam @indhub @jiajiechen Please take a look.