Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[DOC] Fix doc for nn.Embedding, nn.Dense and nd.Embedding #15869

Merged
merged 2 commits into from
Sep 6, 2019
Merged

[DOC] Fix doc for nn.Embedding, nn.Dense and nd.Embedding #15869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad0db62
Update basic_layers.py
eric-haibin-lin Aug 12, 2019
a811563
Update indexing_op.cc
eric-haibin-lin Aug 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions python/mxnet/gluon/nn/basic_layers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,9 @@ class Dense(HybridBlock):
created by the layer, and `bias` is a bias vector created by the layer
(only applicable if `use_bias` is `True`).

Note: the input must be a tensor with rank 2. Use `flatten` to convert it
to rank 2 manually if necessary.
.. note::
the input must be a tensor with rank 2. Use `flatten` to convert it
to rank 2 manually if necessary.

Parameters
----------
Expand Down Expand Up @@ -374,11 +375,13 @@ class Embedding(HybridBlock):
r"""Turns non-negative integers (indexes/tokens) into dense vectors
of fixed size. eg. [4, 20] -> [[0.25, 0.1], [0.6, -0.2]]

Note: if `sparse_grad` is set to True, the gradient w.r.t weight will be
sparse. Only a subset of optimizers support sparse gradients, including SGD, AdaGrad
and Adam. By default lazy updates is turned on, which may perform differently
from standard updates. For more details, please check the Optimization API at:
https://mxnet.incubator.apache.org/api/python/optimization/optimization.html
.. note::
if `sparse_grad` is set to True, the gradient w.r.t weight will be
sparse. Only a subset of optimizers support sparse gradients, including SGD,
AdaGrad and Adam. By default lazy updates is turned on, which may perform
differently from standard updates. For more details, please check the
Optimization API at:
https://mxnet.incubator.apache.org/api/python/optimization/optimization.html

Parameters
----------
Expand Down
5 changes: 3 additions & 2 deletions src/operator/tensor/indexing_op.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,8 +481,9 @@ All the input values should be integers in the range [0, input_dim).
If the input_dim is ip0 and output_dim is op0, then shape of the embedding weight matrix must be
(ip0, op0).

By default, if any index mentioned is too large, it is replaced by the index that addresses
the last vector in an embedding matrix.
When "sparse_grad" is False, if any index mentioned is too large, it is replaced by the index that
addresses the last vector in an embedding matrix.
When "sparse_grad" is True, an error will be raised if invalid indices are found.

Examples::

Expand Down