8000 MAINT, DOC: make np._from_dlpack public by tirthasheshpatel · Pull Request #21145 · numpy/numpy · GitHub
[go: up one dir, main page]
Skip to content

MAINT, DOC: make np._from_dlpack public #21145

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

Merged
merged 10 commits into from
Mar 10, 2022
Merged

MAINT, DOC: make np._from_dlpack public #21145

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
945e0ae
MAINT: make np._from_dlpack public
tirthasheshpatel Mar 3, 2022
492489f
DOC: add the DLPack protocol to interpolability docs
tirthasheshpatel Mar 3, 2022
87a4c8e
TST: np._from_dlpack -> np.from_dlpack
tirthasheshpatel Mar 3, 2022
bbf6993
DOC: fix refguide failure
tirthasheshpatel Mar 3, 2022
dd4b167
DOC: np.from_dlpack: add ``__dlpack_device__`` to the docs
tirthasheshpatel Mar 8, 2022
01d6bce
DOC: make links to DLPack intersphinx
tirthasheshpatel Mar 9, 2022
baac336
DOC: use ELLIPSIS in error message and add note about copying
tirthasheshpatel Mar 9, 2022
d3290b6
Merge branch 'fix-gh20743' of github.com:tirthasheshpatel/numpy into …
tirthasheshpatel Mar 9, 2022
464a124
DOC: `from_dlpack(x)` to `numpy.from_dlpack`
tirthasheshpatel Mar 9, 2022
586d675
Add from_dlpack to upcoming_changes
tirthasheshpatel Mar 9, 2022
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
Prev Previous commit
Next Next commit
DOC: make links to DLPack intersphinx
  • Loading branch information
@tirthasheshpatel
tirthasheshpatel committed Mar 9, 2022
commit 01d6bce0009033184571d58ce506050e5216913c
1 change: 1 addition & 0 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,7 @@ def setup(app):
'pytest': ('https://docs.pytest.org/en/stable', None),
'numpy-tutorials': ('https://numpy.org/numpy-tutorials', None),
'numpydoc': ('https://numpydoc.readthedocs.io/en/latest', None),
'dlpack': ('https://dmlc.github.io/dlpack/latest', None)
}


Expand Down
26 changes: 14 additions & 12 deletions doc/source/user/basics.interoperability.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,13 @@ describes its memory layout and NumPy does everything else (zero-copy if
possible). If that's not possible, the object itself is responsible for
returning a ``ndarray`` from ``__array__()``.

DLPack_ is yet another protocol to convert foriegn objects to NumPy arrays in
a language and device agnostic manner. NumPy doesn't implicitly convert objects
to ndarrays using DLPack. It provides the function `numpy.from_dlpack` that
accepts any object implementing the ``__dlpack__`` method and outputs a NumPy
ndarray (which is generally a view of the input object's data buffer). The
`Python specification for DLPack <https://dmlc.github.io/dlpack/latest/python_spec.html>`_
page explains the ``__dlpack__`` protocol in detail.
:doc:`DLPack <dlpack:index>` is yet another protocol to convert foriegn objects
to NumPy arrays in a language and device agnostic manner. NumPy doesn't implicitly
convert objects to ndarrays using DLPack. It provides the function
`numpy.from_dlpack` that accepts any object implementing the ``__dlpack__`` method
and outputs a NumPy ndarray (which is generally a view of the input object's data
buffer). The :ref:`dlpack:python-spec` page explains the ``__dlpack__`` protocol
in detail.

The array interface protocol
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -129,8 +129,9 @@ To see an example of a custom array implementation including the use of
The DLPack Protocol
~~~~~~~~~~~~~~~~~~~

The DLPack_ protocol defines a memory-layout of strided n-dimensional array
objects. It offers the following syntax for data exchange:
The :doc:`DLPack <dlpack:index>` protocol defines a memory-layout of
strided n-dimensional array objects. It offers the following syntax
for data exchange:

1. A ``from_dlpack(x)`` function, which accepts (array) objects with a
``__dlpack__`` method and uses that method to construct a new array
Expand Down Expand Up @@ -427,8 +428,8 @@ Example: DLPack

Several Python data science libraries implement the ``__dlpack__`` protocol.
Among them are PyTorch_ and CuPy_. A full list of libraries that implement
this protocol can be found on `this page of DLPack
documentation <https://dmlc.github.io/dlpack/latest/#purpose>`_.
this protocol can be found on
:doc:`this page of DLPack documentation <dlpack:index>`.

Convert a PyTorch CPU tensor to NumPy array:

Expand All @@ -448,6 +449,8 @@ Convert a PyTorch CPU tensor to NumPy array:

The imported arrays are read-only so writing or operating in-place will fail:

>>> x.flags.writeable
False
>>> x_np[1] = 1
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
Expand Down Expand Up @@ -516,4 +519,3 @@ Further reading
.. _astropy.units: https://docs.astropy.org/en/stable/units/
.. _pint: https://pint.readthedocs.io/
.. _unyt: https://unyt.readthedocs.io/
.. _DLPack: https://dmlc.github.io/dlpack/latest
0