Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in / Register
Toggle navigation
N
ngraph
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Packages
Packages
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
submodule
ngraph
Commits
0e6c9c26
Commit
0e6c9c26
authored
Oct 05, 2018
by
Scott Cyphers
Committed by
Robert Kimball
Oct 05, 2018
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Cyphers/doc1 (#1758)
* More op doc, fix formatting * sqrt, tan * Formatting.
parent
0920ed1c
Hide whitespace changes
Inline
Side-by-side
Showing
30 changed files
with
319 additions
and
56 deletions
+319
-56
abs.rst
doc/sphinx/source/ops/abs.rst
+1
-1
acos.rst
doc/sphinx/source/ops/acos.rst
+2
-2
asin.rst
doc/sphinx/source/ops/asin.rst
+2
-2
atan.rst
doc/sphinx/source/ops/atan.rst
+2
-2
ceiling.rst
doc/sphinx/source/ops/ceiling.rst
+1
-1
cos.rst
doc/sphinx/source/ops/cos.rst
+2
-2
cosh.rst
doc/sphinx/source/ops/cosh.rst
+2
-2
equal.rst
doc/sphinx/source/ops/equal.rst
+1
-1
exp.rst
doc/sphinx/source/ops/exp.rst
+2
-2
floor.rst
doc/sphinx/source/ops/floor.rst
+1
-1
function_call.rst
doc/sphinx/source/ops/function_call.rst
+1
-1
greater.rst
doc/sphinx/source/ops/greater.rst
+1
-1
greater_eq.rst
doc/sphinx/source/ops/greater_eq.rst
+1
-1
index.rst
doc/sphinx/source/ops/index.rst
+10
-0
less.rst
doc/sphinx/source/ops/less.rst
+1
-1
less_eq.rst
doc/sphinx/source/ops/less_eq.rst
+1
-1
log.rst
doc/sphinx/source/ops/log.rst
+2
-2
max_pool.rst
doc/sphinx/source/ops/max_pool.rst
+1
-1
negative.rst
doc/sphinx/source/ops/negative.rst
+1
-1
not.rst
doc/sphinx/source/ops/not.rst
+1
-1
not_equal.rst
doc/sphinx/source/ops/not_equal.rst
+1
-1
sign.rst
doc/sphinx/source/ops/sign.rst
+50
-0
sin.rst
doc/sphinx/source/ops/sin.rst
+57
-0
sinh.rst
doc/sphinx/source/ops/sinh.rst
+57
-0
softmax.rst
doc/sphinx/source/ops/softmax.rst
+3
-3
sqrt.rst
doc/sphinx/source/ops/sqrt.rst
+57
-0
tan.rst
doc/sphinx/source/ops/tan.rst
+57
-0
tanh.rst
doc/sphinx/source/ops/tanh.rst
+1
-1
sign.hpp
src/ngraph/op/sign.hpp
+0
-13
sinh.hpp
src/ngraph/op/sinh.hpp
+0
-12
No files found.
doc/sphinx/source/ops/abs.rst
View file @
0e6c9c26
...
...
@@ -12,7 +12,7 @@ Abs
Description
===========
Produces a single output tensor of the same element type and shape as ``arg
``,
Produces a single output tensor of the same element type and shape as ``arg
,``
where the value at each coordinate of ``output`` is the absolute value of the
value at each ``arg`` coordinate.
...
...
doc/sphinx/source/ops/acos.rst
View file @
0e6c9c26
...
...
@@ -12,9 +12,9 @@ Acos
Description
===========
Produces a tensor of the same element type and shape as ``arg
``,
where the
Produces a tensor of the same element type and shape as ``arg
,``
where the
value at each coordinate of ``output`` is the inverse cosine of the value
at the corresponding coordinate of ``arg
``.
at the corresponding coordinate of ``arg
.``
Inputs
------
...
...
doc/sphinx/source/ops/asin.rst
View file @
0e6c9c26
...
...
@@ -12,9 +12,9 @@ Asin
Description
===========
Produces a tensor of the same element type and shape as ``arg
``,
Produces a tensor of the same element type and shape as ``arg
,``
where the value at each coordinate of ``output`` is the inverse sine of the
value at the corresponding coordinate of ``arg
``.
value at the corresponding coordinate of ``arg
.``
Inputs
------
...
...
doc/sphinx/source/ops/atan.rst
View file @
0e6c9c26
...
...
@@ -12,9 +12,9 @@ Atan
Description
===========
Produces a tensor of the same element type and shape as ``arg
``,
Produces a tensor of the same element type and shape as ``arg
,``
where the value at each coordinate of ``output`` is the inverse tangent of the
value at the corresponding coordinate of ``arg
``.
value at the corresponding coordinate of ``arg
.``
Inputs
------
...
...
doc/sphinx/source/ops/ceiling.rst
View file @
0e6c9c26
...
...
@@ -12,7 +12,7 @@ Ceiling
Description
===========
Produces a single output tensor of the same element type and shape as ``arg
``,
Produces a single output tensor of the same element type and shape as ``arg
,``
where the value at each coordinate of ``output`` is the ceiling of the
value at each ``arg`` coordinate.
...
...
doc/sphinx/source/ops/cos.rst
View file @
0e6c9c26
...
...
@@ -12,9 +12,9 @@ Cos
Description
===========
Produces a tensor of the same element type and shape as ``arg
``,
Produces a tensor of the same element type and shape as ``arg
,``
where the value at each coordinate of ``output`` is the cosine of the
value at the corresponding coordinate of ``arg
``.
value at the corresponding coordinate of ``arg
.``
Inputs
------
...
...
doc/sphinx/source/ops/cosh.rst
View file @
0e6c9c26
...
...
@@ -12,9 +12,9 @@ Cosh
Description
===========
Produces a tensor of the same element type and shape as ``arg
``,
where
Produces a tensor of the same element type and shape as ``arg
,``
where
the value at each coordinate of ``output`` is the hyperbolic cosine of
the value at the corresponding coordinate of ``arg
``.
the value at the corresponding coordinate of ``arg
.``
Inputs
------
...
...
doc/sphinx/source/ops/equal.rst
View file @
0e6c9c26
...
...
@@ -14,7 +14,7 @@ Description
Produces tensor of the same element type and shape as the two inputs,
where the value at each coordinate of ``output`` is ``1`` (true) if
``arg0`` is equal to ``arg1
``,
``0`` otherwise.
``arg0`` is equal to ``arg1
,``
``0`` otherwise.
Inputs
...
...
doc/sphinx/source/ops/exp.rst
View file @
0e6c9c26
...
...
@@ -12,9 +12,9 @@ Exp
Description
===========
Produces a tensor of the same element type and shape as ``arg
``,
Produces a tensor of the same element type and shape as ``arg
,``
where the value at each coordinate of ``output`` is the expine of the
value at the corresponding coordinate of ``arg
``.
value at the corresponding coordinate of ``arg
.``
Inputs
------
...
...
doc/sphinx/source/ops/floor.rst
View file @
0e6c9c26
...
...
@@ -11,7 +11,7 @@ Floor
Description
===========
Produces a single output tensor of the same element type and shape as ``arg
``,
Produces a single output tensor of the same element type and shape as ``arg
,``
where the value at each coordinate of ``output`` is the floor of the
value at each ``arg`` coordinate.
...
...
doc/sphinx/source/ops/function_call.rst
View file @
0e6c9c26
...
...
@@ -12,7 +12,7 @@ FunctionCall
Description
===========
Calls the specified function on ``args
``.
The results of the function are the outputs
Calls the specified function on ``args
.``
The results of the function are the outputs
of the op.
Inputs
...
...
doc/sphinx/source/ops/greater.rst
View file @
0e6c9c26
...
...
@@ -14,7 +14,7 @@ Description
Produces tensor of the same element type and shape as the two inputs,
where the value at each coordinate of ``output`` is true (1) if
``arg0`` is greater than ``arg1
``,
0 otherwise.
``arg0`` is greater than ``arg1
,``
0 otherwise.
Inputs
------
...
...
doc/sphinx/source/ops/greater_eq.rst
View file @
0e6c9c26
...
...
@@ -14,7 +14,7 @@ Description
Produces tensor of the same element type and shape as the two inputs,
where the value at each coordinate of ``output`` is true (1) if
``arg0`` is greater than or equal to ``arg1
``,
0 otherwise.
``arg0`` is greater than or equal to ``arg1
,``
0 otherwise.
Inputs
------
...
...
doc/sphinx/source/ops/index.rst
View file @
0e6c9c26
...
...
@@ -95,7 +95,12 @@ Not currently a comprehensive list.
* :doc:`product`
* :doc:`relu`
* :doc:`sigmoid`
* :doc:`sign`
* :doc:`sin`
* :doc:`sinh`
* :doc:`softmax`
* :doc:`sqrt`
* :doc:`tan`
* :doc:`tanh`
...
...
@@ -151,7 +156,12 @@ Not currently a comprehensive list.
product.rst
relu.rst
sigmoid.rst
sign.rst
sin.rst
sinh.rst
softmax.rst
sqrt.rst
tan.rst
tanh.rst
doc/sphinx/source/ops/less.rst
View file @
0e6c9c26
...
...
@@ -14,7 +14,7 @@ Description
Produces tensor of the same element type and shape as the two inputs,
where the value at each coordinate of ``output`` is true (1) if
``arg0`` is less than ``arg1
``,
0 otherwise.
``arg0`` is less than ``arg1
,``
0 otherwise.
Inputs
------
...
...
doc/sphinx/source/ops/less_eq.rst
View file @
0e6c9c26
...
...
@@ -14,7 +14,7 @@ Description
Produces tensor of the same element type and shape as the two inputs,
where the value at each coordinate of ``output`` is true (1) if
``arg0`` is less than or equal to ``arg1
``,
0 otherwise.
``arg0`` is less than or equal to ``arg1
,``
0 otherwise.
Inputs
------
...
...
doc/sphinx/source/ops/log.rst
View file @
0e6c9c26
...
...
@@ -13,9 +13,9 @@ Log
Description
===========
Produces a tensor of the same element type and shape as ``arg
``,
Produces a tensor of the same element type and shape as ``arg
,``
where the value at each coordinate of ``output`` is the logine of the
value at the corresponding coordinate of ``arg
``.
value at the corresponding coordinate of ``arg
.``
Inputs
------
...
...
doc/sphinx/source/ops/max_pool.rst
View file @
0e6c9c26
...
...
@@ -53,7 +53,7 @@ The input for max pooling is a data batch tensor of shape
:math:`(N,C,d_1,\dots,d_n)` where :math:`n > 0`, every :math:`d_i >
0`, and where :math:`N` is the batch size, and :math:`C > 0` is the
number of channels (sometimes called features). The dimensions
:math:`(d_1,\dots,d_n` correspond to the shape of an
:math:`(d_1,\dots,d_n
)
` correspond to the shape of an
:math:`n`-dimensional data item in a batch. For example, where
:math:`n=2`, the data may represent a two-dimensional image. It also
has two attributes:
...
...
doc/sphinx/source/ops/negative.rst
View file @
0e6c9c26
...
...
@@ -12,7 +12,7 @@ Negative
Description
===========
Produces a single output tensor of the same element type and shape as ``arg
``,
Produces a single output tensor of the same element type and shape as ``arg
,``
where the value at each coordinate of ``output`` is the negative of the
value at each ``arg`` coordinate.
...
...
doc/sphinx/source/ops/not.rst
View file @
0e6c9c26
...
...
@@ -12,7 +12,7 @@ Not
Description
===========
Produces a single output tensor of boolean type and the same shape as ``arg
``,
Produces a single output tensor of boolean type and the same shape as ``arg
,``
where the value at each coordinate of ``output`` is the negation of the
value at each ``arg`` coordinate.
...
...
doc/sphinx/source/ops/not_equal.rst
View file @
0e6c9c26
...
...
@@ -14,7 +14,7 @@ Description
Produces tensor of the same element type and shape as the two inputs,
where the value at each coordinate of ``output`` is ``1`` (true) if
``arg0`` is not equal to ``arg1
``,
``0`` otherwise.
``arg0`` is not equal to ``arg1
,``
``0`` otherwise.
Inputs
...
...
doc/sphinx/source/ops/sign.rst
0 → 100644
View file @
0e6c9c26
.. sign.rst:
####
Sign
####
.. code-block:: cpp
Sign // Elementwise sign operation
Description
===========
Produces a tensor of the same element type and shape as ``arg,``
where the value at each coordinate of ``output`` is the sign (-1, 0, 1)
of the value at the corresponding coordinate of ``arg.``
Inputs
------
+-----------------+-------------------------+--------------------------------+
| Name | Element Type | Shape |
+=================+=========================+================================+
| ``arg`` | Any | Any |
+-----------------+-------------------------+--------------------------------+
Outputs
-------
+-----------------+-------------------------+--------------------------------+
| Name | Element Type | Shape |
+=================+=========================+================================+
| ``output`` | Same as ``arg`` | Same as ``arg`` |
+-----------------+-------------------------+--------------------------------+
Mathematical Definition
=======================
.. math::
\mathtt{output}_{i_0, \ldots, i_{n-1}} = \mathtt{sgn}(\mathtt{arg}_{i_0, \ldots, i_{n-1}})
C++ Interface
=============
.. doxygenclass:: ngraph::op::Sign
:project: ngraph
:members:
doc/sphinx/source/ops/sin.rst
0 → 100644
View file @
0e6c9c26
.. sin.rst:
###
Sin
###
.. code-block:: cpp
Sin // Elementwise sine operation
Description
===========
Produces a tensor of the same element type and shape as ``arg,``
where the value at each coordinate of ``output`` is the sine
of the value at the corresponding coordinate of ``arg.``
Inputs
------
+-----------------+-------------------------+--------------------------------+
| Name | Element Type | Shape |
+=================+=========================+================================+
| ``arg`` | Any | Any |
+-----------------+-------------------------+--------------------------------+
Outputs
-------
+-----------------+-------------------------+--------------------------------+
| Name | Element Type | Shape |
+=================+=========================+================================+
| ``output`` | Same as ``arg`` | Same as ``arg`` |
+-----------------+-------------------------+--------------------------------+
Mathematical Definition
=======================
.. math::
\mathtt{output}_{i_0, \ldots, i_{n-1}} = \sin(\mathtt{arg}_{i_0, \ldots, i_{n-1}})
Backprop
========
.. math::
\overline{\mathtt{arg}} \leftarrow \Delta\ \cos(\mathtt{arg})
C++ Interface
=============
.. doxygenclass:: ngraph::op::Sin
:project: ngraph
:members:
doc/sphinx/source/ops/sinh.rst
0 → 100644
View file @
0e6c9c26
.. sinh.rst:
####
Sinh
####
.. code-block:: cpp
Sinh // Elementwise hyperbolic sine operation
Description
===========
Produces a tensor of the same element type and shape as ``arg,``
where the value at each coordinate of ``output`` is the hyperbolic sine
of the value at the corresponding coordinate of ``arg.``
Inputs
------
+-----------------+-------------------------+--------------------------------+
| Name | Element Type | Shape |
+=================+=========================+================================+
| ``arg`` | Any | Any |
+-----------------+-------------------------+--------------------------------+
Outputs
-------
+-----------------+-------------------------+--------------------------------+
| Name | Element Type | Shape |
+=================+=========================+================================+
| ``output`` | Same as ``arg`` | Same as ``arg`` |
+-----------------+-------------------------+--------------------------------+
Mathematical Definition
=======================
.. math::
\mathtt{output}_{i_0, \ldots, i_{n-1}} = \sinh(\mathtt{arg}_{i_0, \ldots, i_{n-1}})
Backprop
========
.. math::
\overline{\mathtt{arg}} \leftarrow \Delta\ \cosh(\mathtt{arg})
C++ Interface
=============
.. doxygenclass:: ngraph::op::Sinh
:project: ngraph
:members:
doc/sphinx/source/ops/softmax.rst
View file @
0e6c9c26
...
...
@@ -12,10 +12,10 @@ Softmax
Description
===========
Produces a tensor of the same element type and shape as ``arg
``,
Produces a tensor of the same element type and shape as ``arg
,``
where the value at each coordinate of ``output`` is the expine of the
value of the corresponding coordinate of ``arg`` divided by the sum
of the expine of all coordinates of ``arg`` in the specified ``axes
``.
of the expine of all coordinates of ``arg`` in the specified ``axes
.``
Inputs
------
...
...
@@ -49,7 +49,7 @@ Mathematical Definition
.. math::
\
texttt{output}_{i} = \frac{\exp(\texttt{arg}_{i})}{\sum_{j} \exp(\text
tt{arg}_{j})}
\
mathtt{output}_{i} = \frac{\exp(\mathtt{arg}_{i})}{\sum_{j} \exp(\math
tt{arg}_{j})}
C++ Interface
...
...
doc/sphinx/source/ops/sqrt.rst
0 → 100644
View file @
0e6c9c26
.. sqrt.rst:
####
Sqrt
####
.. code-block:: cpp
Sqrt // Elementwise square root operation
Description
===========
Produces a tensor of the same element type and shape as ``arg,``
where the value at each coordinate of ``output`` is the square root
of the value at the corresponding coordinate of ``arg.``
Inputs
------
+-----------------+-------------------------+--------------------------------+
| Name | Element Type | Shape |
+=================+=========================+================================+
| ``arg`` | Any | Any |
+-----------------+-------------------------+--------------------------------+
Outputs
-------
+-----------------+-------------------------+--------------------------------+
| Name | Element Type | Shape |
+=================+=========================+================================+
| ``output`` | Same as ``arg`` | Same as ``arg`` |
+-----------------+-------------------------+--------------------------------+
Mathematical Definition
=======================
.. math::
\mathtt{output}_{i_0, \ldots, i_{n-1}} = \sqrt{\mathtt{arg}_{i_0, \ldots, i_{n-1}}}
Backprop
========
.. math::
\overline{\mathtt{arg}} \leftarrow \frac{\Delta}{2\cdot \mathtt{output}}
C++ Interface
=============
.. doxygenclass:: ngraph::op::Sqrt
:project: ngraph
:members:
doc/sphinx/source/ops/tan.rst
0 → 100644
View file @
0e6c9c26
.. tan.rst:
###
Tan
###
.. code-block:: cpp
Tan // Elementwise tangent operation
Description
===========
Produces a tensor of the same element type and shape as ``arg,``
where the value at each coordinate of ``output`` is the tangent
of the value at the corresponding coordinate of ``arg.``
Inputs
------
+-----------------+-------------------------+--------------------------------+
| Name | Element Type | Shape |
+=================+=========================+================================+
| ``arg`` | Any | Any |
+-----------------+-------------------------+--------------------------------+
Outputs
-------
+-----------------+-------------------------+--------------------------------+
| Name | Element Type | Shape |
+=================+=========================+================================+
| ``output`` | Same as ``arg`` | Same as ``arg`` |
+-----------------+-------------------------+--------------------------------+
Mathematical Definition
=======================
.. math::
\mathtt{output}_{i_0, \ldots, i_{n-1}} = \tan(\mathtt{arg}_{i_0, \ldots, i_{n-1}})
Backprop
========
.. math::
\overline{\mathtt{arg}} \leftarrow \frac{\Delta}{\cos^2(\mathtt{arg})}
C++ Interface
=============
.. doxygenclass:: ngraph::op::Tan
:project: ngraph
:members:
doc/sphinx/source/ops/tanh.rst
View file @
0e6c9c26
...
...
@@ -47,7 +47,7 @@ Backprop
.. math::
\overline{\mathtt{arg}} \leftarrow \Delta\ (1 - \
text
tt{output}^2)
\overline{\mathtt{arg}} \leftarrow \Delta\ (1 - \
math
tt{output}^2)
C++ Interface
...
...
src/ngraph/op/sign.hpp
View file @
0e6c9c26
...
...
@@ -24,19 +24,6 @@ namespace ngraph
{
/// \brief Elementwise sign operation.
///
/// Maps each element of the input tensor to -1 (if it is negative), 0 (if it is zero), or 1 (if it is positive).
///
/// ## Inputs
///
/// | | Type | Description |
/// | ----- | --------------------------------- | ----------------------------------------------- |
/// | `arg` | \f$N[d_1,\dots,d_n]~(n \geq 0)\f$ | A tensor of any shape and numeric element type. |
///
/// ## Output
///
/// | Type | Description |
/// | ---------------------- | ------------------------------------------------------------------------------------ |
/// | \f$N[d_1,\dots,d_n]\f$ | The tensor \f$T\f$, where \f$T[i_1,\dots,i_n] = \text{sgn}(\texttt{arg}[i_1,\dots,i_n])\f$ |
class
Sign
:
public
util
::
UnaryElementwiseArithmetic
{
public
:
...
...
src/ngraph/op/sinh.hpp
View file @
0e6c9c26
...
...
@@ -23,18 +23,6 @@ namespace ngraph
namespace
op
{
/// \brief Elementwise hyperbolic sine (sinh) operation.
///
/// ## Inputs
///
/// | | Type | Description |
/// | ----- | --------------------------------- | ----------------------------------------------- |
/// | `arg` | \f$N[d_1,\dots,d_n]~(n \geq 0)\f$ | A tensor of any shape and numeric element type. |
///
/// ## Output
///
/// | Type | Description |
/// | ---------------------- | ------------------------------------------------------------------------------------- |
/// | \f$N[d_1,\dots,d_n]\f$ | The tensor \f$T\f$, where \f$T[i_1,\dots,i_n] = \sinh(\texttt{arg}[i_1,\dots,i_n])\f$ |
class
Sinh
:
public
util
::
UnaryElementwiseArithmetic
{
public
:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment