add example for links.EmbedID

chainer · Aug 5, 2017 · 3717dbf · 3717dbf
1 parent 978ce99
commit 3717dbf
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 3 deletions.
diff --git a/chainer/functions/connection/embed_id.py b/chainer/functions/connection/embed_id.py
@@ -117,8 +117,8 @@ def embed_id(x, W, ignore_label=None):
         >>> x
         array([2, 1], dtype=int32)
         >>> W = np.array([[0, 0, 0],
-                          [1, 1, 1],
-                          [2, 2, 2]]).astype('f')
+        ...               [1, 1, 1],
+        ...               [2, 2, 2]]).astype('f')
         >>> W
         array([[ 0.,  0.,  0.],
                [ 1.,  1.,  1.],

diff --git a/chainer/links/connection/embed_id.py b/chainer/links/connection/embed_id.py
@@ -22,11 +22,29 @@ class EmbedID(link.Link):
         ignore_label (int or None): If ``ignore_label`` is an int value,
             ``i``-th column of return value is filled with ``0``.
 
-    .. seealso:: :func:`chainer.functions.embed_id`
+    .. seealso:: :func:`~chainer.functions.embed_id`
 
     Attributes:
         W (~chainer.Variable): Embedding parameter matrix.
 
+    .. admonition:: Example
+
+        >>> W = np.array([[0, 0, 0],
+        ...               [1, 1, 1],
+        ...               [2, 2, 2]]).astype('f')
+        >>> W
+        array([[ 0.,  0.,  0.],
+               [ 1.,  1.,  1.],
+               [ 2.,  2.,  2.]], dtype=float32)
+        >>> l = L.EmbedID(W.shape[0], W.shape[1], initialW=W)
+        >>> x = np.array([2, 1]).astype('i')
+        >>> x
+        array([2, 1], dtype=int32)
+        >>> y = l(x)
+        >>> y.data
+        array([[ 2.,  2.,  2.],
+               [ 1.,  1.,  1.]], dtype=float32)
+
     """
 
     ignore_label = None