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

Improve Tensors docs #2915

Merged
merged 3 commits into from
May 10, 2021
Merged

Improve Tensors docs #2915

merged 3 commits into from
May 10, 2021

Conversation

klecki
Copy link
Contributor

@klecki klecki commented Apr 30, 2021

  • Expose the CUDA and NumPy Array Interface
  • Add links to the above
  • Add a paragraph about the memory being wrapped
  • Mention that the memory is invalidated in subsequent iteration
  • Add better cross-links
  • Turn on plugin for section labels (easy links in one .rst)
  • After this is merged (visibility changes only) file a PR to numba so it mentions DALI as supporting CUDA Array Interface.

Signed-off-by: Krzysztof Lecki klecki@nvidia.com

Why we need this PR?

  • Refactoring to improve docs

What happened in this PR?

  • What solution was applied:

    • Expose the CUDA and NumPy Array Interface
    • Add links to the above
    • Add a paragraph about the memory being wrapped
    • Mention that the memory is invalidated in subsequent iteration
    • Add better cross-links
    • Turn on plugin for section labels (easy links in one .rst)
  • Affected modules and functionalities:
    Types -> Tensor docs mostly

  • Key points relevant for the review:
    If what I wrote is true.

  • Validation and testing:
    Read the docs, please.

  • Documentation (including examples):
    Yes, indeed.

JIRA TASK: [Use DALI-XXXX or NA]

* Expose the CUDA and NumPy Array Interface
* Add links to the above
* Add a paragraph about the memory being wrapped
* Mention that the memory is invalidated in subsequent iteration
* Add better cross-links
* Turn on plugin for section labels (easy links in one .rst)

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
@klecki
Copy link
Contributor Author

klecki commented Apr 30, 2021

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [2322569]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [2322569]: BUILD FAILED

@JanuszL JanuszL self-assigned this Apr 30, 2021
)code");
tensor_cpu_binding.doc() = R"code(
Class representing a Tensor with memory residing on CPU. It can be used to access individual
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Class representing a Tensor with memory residing on CPU. It can be used to access individual
Class representing a Tensor residing in host memory. It can be used to access individual

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

)code");
tensor_gpu_binding.doc() = R"code(
Class representing a Tensor with memory residing on GPU. It can be used to access individual
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Class representing a Tensor with memory residing on GPU. It can be used to access individual
Class representing a Tensor residing in GPU memory. It can be used to access individual

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Needed when the docs is built without DALI source repo,
as only installed DALI is needed for it.

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
@klecki
Copy link
Contributor Author

klecki commented May 10, 2021

!build

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [2352616]: BUILD STARTED

@dali-automaton
Copy link
Collaborator

CI MESSAGE: [2352616]: BUILD PASSED

@klecki klecki merged commit b00f2f8 into NVIDIA:master May 10, 2021
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.

5 participants