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.

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

Fix Pipeline docs formatting #5283

Merged
merged 1 commit into from
Jan 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions dali/python/nvidia/dali/pipeline.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2017-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# Copyright (c) 2017-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -125,16 +125,13 @@ class Pipeline(object):

More details can be found in
`this documentation section <advanced_topics_checkpointing.html>`_.


`checkpoint`: str, optional, default = None
Serialized checkpoint, received from ``checkpoint`` method.
When pipeline is built, its state is restored from the `checkpoint` and the pipeline
resumes execution from the saved iteration.

More details can be found in
`this documentation section <advanced_topics_checkpointing.html>`_.

`py_num_workers`: int, optional, default = 1
The number of Python workers that will process ``ExternalSource`` callbacks.
The pool starts only if there is at least one ExternalSource with ``parallel`` set to True.
Expand Down