Updates the pipeline docs page #2824
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
- removes duplicated pipeline description from the pipeline docs page - makes Pipeline.current() method documented - adds an example of how to use Pipeline.current() in the Pipeline Decorator section Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
|
!build |
|
CI MESSAGE: [2214847]: BUILD STARTED |
|
CI MESSAGE: [2214847]: BUILD PASSED |
dali/python/nvidia/dali/pipeline.py
Outdated
Comment on lines
1279
to
1280
| To obtain a value of the argument added and consumed by the ``@pipeline_def`` the user need to | ||
| to use :meth:`nvidia.dali.Pipeline.current()` and query for the required value:: |
There was a problem hiding this comment.
Suggested change
| To obtain a value of the argument added and consumed by the ``@pipeline_def`` the user need to | |
| to use :meth:`nvidia.dali.Pipeline.current()` and query for the required value:: | |
| To access any pipeline arguments within the body of a ``@pipeline_def`` function, the function | |
| :meth:`nvidia.dali.Pipeline.current()` can be used:: |
dali/python/nvidia/dali/pipeline.py
Outdated
Comment on lines
1282
to
1287
| @pipeline_def(batch_size=42, num_threads=3) | ||
| def my_pipe(flip_vertical, flip_horizontal): | ||
| pipe = Pipeline.current() | ||
| x = pipe.batch_size | ||
| y = pipe.num_threads | ||
| ... |
There was a problem hiding this comment.
Suggested change
| @pipeline_def(batch_size=42, num_threads=3) | |
| def my_pipe(flip_vertical, flip_horizontal): | |
| pipe = Pipeline.current() | |
| x = pipe.batch_size | |
| y = pipe.num_threads | |
| ... | |
| @pipeline_def() | |
| def my_pipe(): | |
| pipe = Pipeline.current() | |
| batch_size = pipe.batch_size | |
| num_threads = pipe.num_threads | |
| ... | |
| pipe = my_pipe(batch_size=42, num_threads=3) | |
| ... |
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
jantonguirao
approved these changes
Mar 31, 2021
banasraf
approved these changes
Apr 1, 2021
|
!build |
|
CI MESSAGE: [2226541]: BUILD STARTED |
|
CI MESSAGE: [2226541]: 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.
section
Signed-off-by: Janusz Lisiecki jlisiecki@nvidia.com
Why we need this PR?
Pick one, remove the rest
What happened in this PR?
Fill relevant points, put NA otherwise. Replace anything inside []
removes duplicated pipeline description from the pipeline docs page
makes Pipeline.current() method documented
adds an example of how to use Pipeline.current() in the Pipeline Decorator
section
pipeline docs page
Wording in the example
CI
Pipeline doc page was updated
JIRA TASK: [NA]