unregister_cache

Applicability

Product

Supported

Atlas A3 training products/Atlas A3 inference products

√

Atlas A2 training products/Atlas A2 inference products

√

Atlas 200I/500 A2 inference products

x

Atlas inference products

x

Atlas training products

x

Note: For the Atlas A2 training products/Atlas A2 inference products, only the Atlas 800I A2 inference server, Atlas 300I A2 inference card, and A200I A2 Box heterogeneous components are supported.

Function Description

Deregisters a self-allocated memory.

Prototype

1
unregister_cache(cache_id: int) -> None

Parameters

Parameter

Data Type

Description

cache_id

int

ID of the cache returned by calling register_cache or register_blocks_cache.

Example

Click Gitcode, select the matching version, and obtain the sample from the examples/python directory.

Returns

In normal cases, no value is returned.

If the input data type is incorrect, a TypeError or ValueError is thrown.

Restrictions

  • This API can be used only when local_comm_res is configured.
  • Before calling this API, you must call unlink to disconnect the link; otherwise, HCCL will report an error.