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

Add improved checkpointing docs #5230

Merged
merged 5 commits into from
Dec 11, 2023
Merged

Conversation

szkarpinski
Copy link
Collaborator

@szkarpinski szkarpinski commented Dec 8, 2023

Category:

Other – docs

Description:

This PR adds "checkpointing" page to DALI docs.

Additional information:

Affected modules and functionalities:

Key points relevant for the review:

My first time writing RST page to DALI docs, something might be wrong in a way you don't expect it to be :)

Tests:

  • Existing tests apply
  • New tests added
    • Python tests
    • GTests
    • Benchmark
    • Other
  • N/A

Checklist

Documentation

  • Existing documentation applies
  • Documentation updated
    • Docstring
    • Doxygen
    • RST
    • Jupyter
    • Other
  • N/A

DALI team only

Requirements

  • Implements new requirements
  • Affects existing requirements
  • N/A

REQ IDs: N/A

JIRA TASK: DALI-3739

Signed-off-by: Szymon Karpiński <skarpinski@nvidia.com>
@stiepan stiepan self-assigned this Dec 8, 2023
@awolant awolant self-assigned this Dec 8, 2023
Signed-off-by: Szymon Karpiński <skarpinski@nvidia.com>
@szkarpinski
Copy link
Collaborator Author

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [11342826]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [11342826]: BUILD PASSED

@NVIDIA NVIDIA deleted a comment from dali-automaton Dec 8, 2023
@NVIDIA NVIDIA deleted a comment from dali-automaton Dec 8, 2023
@NVIDIA NVIDIA deleted a comment from dali-automaton Dec 8, 2023
Copy link
Contributor

@awolant awolant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be some random "the" missing. I recommend copy-pasting the whole content through your favorite method of spell & grammar checking. I paste the whole content to empty Google Docs documment:
image

Other than that LGTM :)

checkpoint = p.checkpoint('checkpoint_file.cpt')

.. note::
Calling :meth:`Pipeline.checkpoint method` may introduce an observable overhead.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

I think this does not look like intended.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed, thank you

Signed-off-by: Szymon Karpiński <skarpinski@nvidia.com>
Signed-off-by: Szymon Karpiński <skarpinski@nvidia.com>
@NVIDIA NVIDIA deleted a comment from dali-automaton Dec 11, 2023
Co-authored-by: Kamil Tokarski <kamiltokarski04@gmail.com>
@szkarpinski
Copy link
Collaborator Author

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [11401688]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [11401688]: BUILD PASSED

@szkarpinski szkarpinski merged commit 39b9be1 into NVIDIA:main Dec 11, 2023
4 of 5 checks passed
stiepan added a commit that referenced this pull request Dec 11, 2023
This PR adds "checkpointing" page to DALI docs.

---------

Signed-off-by: Szymon Karpiński <skarpinski@nvidia.com>
Co-authored-by: Kamil Tokarski <kamiltokarski04@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants