MemPool

class torch.xpu.memory.MemPool(*args, **kwargs)

MemPool represents a pool of memory in a caching allocator. Currently, it’s just the ID of the pool object maintained in the XPUCachingAllocator.

Parameters:

• allocator (torch._C._xpu_XPUAllocator, optional) – a torch._C._xpu_XPUAllocator object that can be used to define how memory gets allocated in the pool. If allocator is None (default), memory allocation follows the default/ current configuration of the XPUCachingAllocator.

• use_on_oom (bool) – a bool that indicates if this pool can be used as a last resort if a memory allocation outside of the pool fails due to Out Of Memory. This is False by default.

property allocator: _xpu_XPUAllocator | None

Returns the allocator this MemPool routes allocations to.

property id: tuple[int, int]

Returns the ID of this pool as a tuple of two ints.

snapshot()

Return a snapshot of the XPU memory allocator pool state across all devices.

Interpreting the output of this function requires familiarity with the memory allocator internals.

use_count()

Returns the reference count of this pool.

Return type:

int