Descriptor
Registers a local memory buffer with the NIXL I/O subsystem for transfer.
Memory descriptor that ensures memory is registered with the NIXL-base I/O subsystem. Memory must be registered with the NIXL subsystem to enable interaction with the memory.
Descriptor objects are administrative and do not copy, move, or otherwise modify the registered memory.
There are four ways to create a descriptor:
-
From a
torch.Tensorobject. Device information will be derived from the provided object. -
From a
tuplecontaining either a NumPy or CuPyndarrayand information describing where the memory resides (Host/CPU vs GPU). -
From a Python
bytesobject. Memory is assumed to reside in CPU addressable host memory. -
From a
tuplecomprised of the address of the memory, its size in bytes, and device information. An optional reference to a Python object can be provided to avoid garbage collection issues.
Methods
register_memory
Instructs the descriptor to register its memory buffer with the NIXL-based I/O subsystem.
The Connector whose NIXL subsystem the descriptor’s memory buffer is registered with.
Calling this method more than once on the same descriptor has no effect.
When the descriptor is assigned to a NIXL operation, it will be automatically registered if was not explicitly registered.
Properties
A reference to the Device that contains the buffer the descriptor represents.
The size of the memory allocation the descriptor represents.