Add docs for arithmetic expressions #1600
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
|
!build |
|
CI MESSAGE: [1042500]: BUILD STARTED |
|
CI MESSAGE: [1042500]: BUILD PASSED |
JanuszL
approved these changes
Dec 21, 2019
jantonguirao
approved these changes
Dec 31, 2019
dali/python/nvidia/dali/types.py
Outdated
| will be passed to DALI as `int32` and the floating point values as `float32`. | ||
| Python builtin types `bool`, `int` and `float` will also be treated as those types. | ||
| """Wrapper for a constant value that can be used in DALI arithmetic expressions | ||
| and applied elemtiwse to the results of DALI Operators representing Tensors in |
There was a problem hiding this comment.
Suggested change
| and applied elemtiwse to the results of DALI Operators representing Tensors in | |
| and applied elementwise to the results of DALI Operators representing Tensors in |
docs/supported_ops.rst
Outdated
| DALI allows using regular Python arithmetic operations within :meth:`~nvidia.dali.pipeline.Pipeline.define_graph` | ||
| method on the values returned from invoking other operators. | ||
|
|
||
| The expressions used will be incorporated into Pipeline without the need to explicitly instantiate operators |
There was a problem hiding this comment.
Suggested change
| The expressions used will be incorporated into Pipeline without the need to explicitly instantiate operators | |
| The expressions used will be incorporated into the Pipeline without the need to explicitly instantiate operators |
docs/supported_ops.rst
Outdated
| The expressions used will be incorporated into Pipeline without the need to explicitly instantiate operators | ||
| and will describe element-wise operations on Tensors. | ||
|
|
||
| At least one of the inputs must be Tensor input that is returned by other DALI Operator. |
There was a problem hiding this comment.
Suggested change
| At least one of the inputs must be Tensor input that is returned by other DALI Operator. | |
| At least one of the inputs must be a Tensor input that is returned by other DALI Operator. |
docs/supported_ops.rst
Outdated
| As the operations performed are element-wise, the shapes of all operands must match. | ||
|
|
||
| .. note:: | ||
| If one of the operands is a batch of Tensors representig scalars the scalar values |
There was a problem hiding this comment.
Suggested change
| If one of the operands is a batch of Tensors representig scalars the scalar values | |
| If one of the operands is a batch of Tensors representing scalars, the scalar values |
docs/supported_ops.rst
Outdated
|
|
||
| .. note:: | ||
| If one of the operands is a batch of Tensors representig scalars the scalar values | ||
| are *broadcasted* to other operand. |
There was a problem hiding this comment.
Suggested change
| are *broadcasted* to other operand. | |
| are *broadcasted* to the other operand. |
docs/supported_ops.rst
Outdated
| .. function:: Unary arithmetic operators: +, - | ||
|
|
||
| Unary operators implementing `__pos__(self)` and `__neg__(self)`. | ||
| The result of unary arithmetic operation always keeps the input type. |
There was a problem hiding this comment.
Suggested change
| The result of unary arithmetic operation always keeps the input type. | |
| The result of a unary arithmetic operation always keeps the input type. |
docs/supported_ops.rst
Outdated
| Type promotions are commutative. | ||
|
|
||
| .. note:: | ||
| Only allowed arithmetic operation between two `bool` values is multiplication `*`. |
There was a problem hiding this comment.
Suggested change
| Only allowed arithmetic operation between two `bool` values is multiplication `*`. | |
| The only allowed arithmetic operation between two `bool` values is multiplication `*`. |
docs/supported_ops.rst
Outdated
|
|
||
| .. function:: Comparison operations: ==, !=, <, <=, >, >= | ||
|
|
||
| Comparison operations. Before applying compa |
docs/supported_ops.rst
Outdated
|
|
||
| .. function:: Bitwise binary operations: &, |, ^ | ||
|
|
||
| The bitwise binary operations abide the same type promotion rules as arithmetic binary operations, |
There was a problem hiding this comment.
Suggested change
| The bitwise binary operations abide the same type promotion rules as arithmetic binary operations, | |
| The bitwise binary operations abide by the same type promotion rules as the arithmetic binary operations, |
docs/supported_ops.rst
Outdated
| but their inputs are restricted to integral types (`bool` included). | ||
|
|
||
| .. note:: | ||
| Bitwise operation can be applied to two boolean inputs. Those operations can be used |
There was a problem hiding this comment.
Suggested change
| Bitwise operation can be applied to two boolean inputs. Those operations can be used | |
| A bitwise operation can be applied to two boolean inputs. Those operations can be used |
|
!build |
|
CI MESSAGE: [1054637]: BUILD STARTED |
Add explicit documentation for arithmetic expressions. As of now they are only documented with verbose examples. This commit adds short documentation for existing operations as well as turns on autodoc for dali.types.Constant. It also adjust the docstring there. Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
|
!build |
|
CI MESSAGE: [1054649]: BUILD STARTED |
|
CI MESSAGE: [1054649]: BUILD PASSED |
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.
Why we need this PR?
To have short, concise and explicit docs for supported arithmetic ops other than verbose examples.
What happened in this PR?
Add explicit documentation for arithmetic
expressions. As of now they are only
documented with verbose examples.
This commit adds short documentation for
existing operations as well as turns
on autodoc for dali.types.Constant.
It also adjust the docstring there.
The formatting is using a bit of a hack to introduce a section title and return type
with
.. function::markerSupported Operations & API docs.
Look if the formatting is ok and the description is clear.
Local & CI docs build
Described above, this is a docs update.
JIRA TASK: [1213]