---
title: allocate_cache
description: "| 产品 | 是否支持 |"
url: https://www.hiascend.com/document/detail/zh/canncommercial/latest/API/hixlug/llmprv2_42_0071.html
sourcePath: /source/zh/canncommercial/900/API/hixlug/llmprv2_42_0071.html
indexId: 8442a4c626beadf9348cb7422690044a9cef3ebc856b9e7f03b4c7de024c2a7b61
---
# allocate_cache

#### 产品支持情况

| 产品 | 是否支持 |
| --- | --- |
| Atlas 350 加速卡 | x |
| Atlas A3 训练系列产品 / Atlas A3 推理系列产品 | √ |
| Atlas A2 训练系列产品 / Atlas A2 推理系列产品 | √ |
| Atlas 200I/500 A2 推理产品 | x |
| Atlas 推理系列产品 | x |
| Atlas 训练系列产品 | x |


说明：针对 Atlas A2 训练系列产品 / Atlas A2 推理系列产品 ，仅支持Atlas 800I A2 推理服务器、A200I A2 Box 异构组件。


#### 函数功能

分配Cache，Cache分配成功后，会同时被cache_id与cache_keys引用，只有当这些引用都解除后，cache所占用的资源才会实际释放。

cache_id的引用需通过deallocate_cache解除，cache_keys的引用则可以通过以下2种方式解除。

- Decode调用  pull_cache
或  push_cache
接口成功后解除。
- PROMPT调用  remove_cache_key
接口时解除。


#### 函数原型

```
allocate_cache(cache_desc: CacheDesc, cache_keys: Union[Tuple[CacheKey], List[CacheKey]] = ())
```


#### 参数说明

| 参数名称 | 数据类型 | 取值说明 |
| --- | --- | --- |
| cache\_desc | CacheDesc | Cache的描述。 |
| cache\_keys | Union[Tuple[CacheKey], List[CacheKey]] | Cache的索引。 |


#### 调用示例

```
from llm_datadist import *
cache_desc = CacheDesc(1, [2, 1024 * 1024], DataType.DT_FLOAT16)
cache_keys = [CacheKey(1, req_id=1), CacheKey(1, req_id=2)]
cache = cache_manager.allocate_cache(cache_desc, cache_keys)
```


#### 返回值

正常情况下返回Cache。

传入数据类型错误情况下会抛出TypeError或ValueError异常。

如果cache_keys中包含了分配内存时绑定的CacheKey，则抛出LLMException异常。

执行时间超过sync_kv_timeout配置会抛出LLMException异常。


#### 约束说明

- 传入cache_keys时，如果Cache的batch size>1，则需要提供相同数量的CacheKey，分别引用一组kv tensor。
- 如果当次推理的batch未占用满，即存在无效batch_index，则需要插入特殊的CacheKey（将req_id设置为UINT64_MAX）占位，如果空闲的batch_index在末尾，则可以省略。
- 如果cache_keys存在重复，则最后一个生效。
- 调用该接口前需要先配置内存池。