Skip to content

Fixed to_pointer/2 docs :kind -> :mode #1578

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 1 commit into from
Feb 4, 2025
Merged

Fixed to_pointer/2 docs :kind -> :mode #1578

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 3 additions & 3 deletions nx/lib/nx.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16812,7 +16812,7 @@ defmodule Nx do

## Options

* `:kind` - one of `:local`, `:ipc`. `:local` means the returned value
* `:mode` - one of `:local`, `:ipc`. `:local` means the returned value
represents a pointer internal to the current process. `:ipc` means
the returned value represents an IPC handle that can be shared between
processes. Defaults to `:local`.
Expand All @@ -16822,11 +16822,11 @@ defmodule Nx do
## Examples

t = Nx.u8([10, 20, 30])
Nx.to_pointer(t, kind: :local)
Nx.to_pointer(t, mode: :local)
%Nx.Pointer{kind: :local, address: 1234, data_size: 3, handle: nil}

t = Nx.s32([1, 2, 3])
Nx.to_pointer(t, kind: :ipc)
Nx.to_pointer(t, mode: :ipc)
%Nx.Pointer{kind: :ipc, address: nil, data_size: 32, handle: "some-ipc-handle"}
"""
@doc type: :creation
Expand Down