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.

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

GH-40801: [Docs] Clarify device identifier documentation in the Arrow C Device data interface #41101

Merged
merged 2 commits into from
Apr 10, 2024
Merged

GH-40801: [Docs] Clarify device identifier documentation in the Arrow C Device data interface #41101

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d83bb3d
clarify text
paleolimbot Apr 9, 2024
f4689ac
clarify
paleolimbot Apr 9, 2024
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
6 changes: 5 additions & 1 deletion docs/source/format/CDeviceDataInterface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,10 @@ has the following fields:
type are on the system. The semantics of the id will be hardware dependent,
but we use an ``int64_t`` to future-proof the id as devices change over time.

For device types that do not have an intrinsic notion of a device identifier (e.g.,
``ARROW_DEVICE_CPU``), it is recommended to use a ``device_id`` of -1 as a
convention.

.. c:member:: ArrowDeviceType ArrowDeviceArray.device_type

*Mandatory.* The type of the device which can access the buffers in the array.
Expand Down Expand Up @@ -689,4 +693,4 @@ Any incompatible changes should be part of a new specification, for example
.. _Vulkan: https://www.vulkan.org/
.. _Metal: https://developer.apple.com/metal/
.. _ROCm: https://www.amd.com/en/graphics/servers-solutions-rocm
.. _oneAPI: https://www.intel.com/content/www/us/en/developer/tools/oneapi/overview.html
.. _oneAPI: https://www.intel.com/content/www/us/en/developer/tools/oneapi/overview.html
Loading