GdsFile

class torch.cuda.gds.GdsFile(filename, flags)

Wrapper around a file registered with the GPUDirect Storage (GDS) driver.

cuFile (CUDA) and hipFile (ROCm) are file-like interfaces to the GDS API.

See the cufile docs and the hipFile docs for more details, and hipFile (GPUDirect Storage) for ROCm specifics.

Parameters:

• filename (str) – Name of the file to open.

• flags (int) – Flags to pass to os.open when opening the file. os.O_DIRECT will be added automatically.

Example:

>>> src1 = torch.randn(1024, device="cuda")
>>> src2 = torch.randn(2, 1024, device="cuda")
>>> file = torch.cuda.gds.GdsFile(f, os.O_CREAT | os.O_RDWR)
>>> file.save_storage(src1.untyped_storage(), offset=0)
>>> file.save_storage(src2.untyped_storage(), offset=src1.nbytes)
>>> dest1 = torch.empty(1024, device="cuda")
>>> dest2 = torch.empty(2, 1024, device="cuda")
>>> file.load_storage(dest1.untyped_storage(), offset=0)
>>> file.load_storage(dest2.untyped_storage(), offset=src1.nbytes)
>>> torch.equal(src1, dest1)
True
>>> torch.equal(src2, dest2)
True

deregister_handle()

Deregisters file descriptor from the GDS driver.

This is a wrapper around cuFileHandleDeregister (CUDA) / hipFileHandleDeregister (ROCm).

load_storage(storage, offset=0)

Loads data from the file into the storage.

This is a wrapper around cuFileRead (CUDA) / hipFileRead (ROCm). storage.nbytes() of data will be loaded from the file at offset into the storage.

Parameters:

• storage (Storage) – Storage to load data into.

• offset (int, optional) – Offset into the file to start loading from. (Default: 0)

register_handle()

Registers file descriptor to the GDS driver.

This is a wrapper around cuFileHandleRegister (CUDA) / hipFileHandleRegister (ROCm).

save_storage(storage, offset=0)

Saves data from the storage into the file.

This is a wrapper around cuFileWrite (CUDA) / hipFileWrite (ROCm). All bytes of the storage will be written to the file at offset.

Parameters:

• storage (Storage) – Storage to save data from.

• offset (int, optional) – Offset into the file to start saving to. (Default: 0)