Skip to content

Commit

Permalink
Fix Pipeline docs formatting (#5283)
Browse files Browse the repository at this point in the history
This commit fixes formatting issues around checkpointing
parameters for Python Pipeline class constructor that caused
the doc to not render correctly.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
  • Loading branch information
klecki authored Jan 19, 2024
1 parent 06ad109 commit 8043c69
Showing 1 changed file with 1 addition and 4 deletions.
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

0 comments on commit 8043c69

Please sign in to comment.