dlpack icon indicating copy to clipboard operation
dlpack copied to clipboard

Circumnavigation in the Python DLPack docs

Open pitrou opened this issue 1 year ago • 2 comments

The page https://dmlc.github.io/dlpack/latest/python_spec.html currently lacks a detailed description of the DLPack Python protocol (for example the __dlpack__ signature). It claims that "More details about the spec can be found under the Data interchange mechanisms page", so one is tempted to follow through that link. However, the linked page does not provide a detailed description of the Python protocol either, and does not link to the actual API docs.

pitrou avatar Mar 07 '24 09:03 pitrou

Apart from full API signatures which I can fix on both sides (make it fully spelled out on the DLPack Python Spec page, and add hyperlinks to the Array API "Data interchange mechanisms" page), what kind of detailed descriptions you think are missing, once you read the four pages (the first two + __dlpack__/__dlpack_device__ docs)?

leofang avatar Mar 07 '24 18:03 leofang

The __dlpack__ API doc(s) should be linked directly from the spec pages IMHO. Otherwise it's too easy to get lost. But, yeah, nothing else is really required.

pitrou avatar Mar 08 '24 14:03 pitrou