Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add missing blocking argument documentation to the external source operator #5501

Merged
merged 3 commits into from
Jun 6, 2024
Merged

Add missing blocking argument documentation to the external source operator #5501

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1953479
Add missing `blocking` argument documentation to the external source …
JanuszL Jun 5, 2024
b5e7e0a
Review fix
JanuszL Jun 5, 2024
2df464d
Fix
JanuszL Jun 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion dali/pipeline/operator/builtin/input_operator.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ A base for any operator that forwards in-memory data to DALI pipeline.)doc")
.NumInput(0)
.NumOutput(0)
.AddOptionalArg("blocking", R"code(
If ``True``, this operator will block until the data is available (e.g. by calling ``feed_input``).
**Advanced** If ``True``, this operator will block until the data is available
(e.g. by calling ``feed_input``).
If ``False``, the operator will raise an error, if the data is not available.
)code", false)
.AddOptionalArg("no_copy", R"code(
Expand Down
5 changes: 5 additions & 0 deletions dali/python/nvidia/dali/external_source.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,6 +460,11 @@ class ExternalSource:
.. note::
This is applicable only when copying data to and from GPU memory.

`blocking`: bool, optional
**Advanced** If True, this operator will block until the data is available
(e.g. by calling ``feed_input``). If False, the operator will raise an error,
if the data is not available.

`no_copy` : bool, optional
Determines whether DALI should copy the buffer when feed_input is called.

Expand Down