生成ES构图API（可选）

前提条件

• 用户已经安装CANN软件包，并设置如下环境变量：（如下环境变量以root用户为例，且CANN软件包安装在默认路径）

  1	source /usr/local/Ascend/cann/set_env.sh

• 用户环境中有如下依赖，且需要满足相应版本要求：
  • CMake版本：>= 3.17
  • Python3：>= 3.7（仅add_es_library_and_whl需要）
  • 安装Python依赖：setuptools、wheel（仅add_es_library_and_whl需要）
• 用户CMake文件中已经定义原型动态库：

  add_library(opgraph_math SHARED)

修改CMake文件

1. 引入函数

   # 添加模块路径，以便CMake可以找到GenerateEsPackage模块
   list(APPEND CMAKE_MODULE_PATH "/usr/local/Ascend/cann/include/ge/cmake")  
   # 查找模块
   find_package(GenerateEsPackage REQUIRED)

   当前版本需要在CMakeLists.txt中手动添加CMAKE_MODULE_PATH。

2. 生成ES构图API
   1. 调用add_es_library_and_whl，生成C/C++动态库、Python wheel包（完整产物：API的载体）：

      add_es_library_and_whl(
          ES_LINKABLE_AND_ALL_TARGET es_math
          OPP_PROTO_TARGET  opgraph_math # 前提条件中的原型库target
          OUTPUT_PATH       ${CMAKE_BINARY_DIR}/output
      )

   2. 调用add_es_library，只生成C/C++动态库（纯C/C++项目使用）：

      add_es_library(
          ES_LINKABLE_AND_ALL_TARGET es_math
          OPP_PROTO_TARGET  opgraph_math
          OUTPUT_PATH       ${CMAKE_BINARY_DIR}/output
      )

   add_es_library_and_whl和add_es_library函数是对gen_esb二进制工具的封装，包括源文件编译和Python whl包的编译打包等行为；该工具已集成到CANN软件包中，工具详细使用请参见gen_esb二进制工具使用。函数中详细参数解释请参见表1。

   表1 CMake文件相关参数解释

   参数	是否必填	说明	示例
   ES_LINKABLE_AND_ALL_TARGET	必填	产物中的Target名称。	es_math、es_nn、es_cv 建议使用es_ 前缀（如es_math、es_nn）。 使用小写字母和下划线。 避免使用特殊字符和C++关键字。
   OPP_PROTO_TARGET	必填	算子原型库的CMake Target名称，针对该原型库中的算子生成对应的ES接口。	opgraph_math、opgraph_nn
   OUTPUT_PATH	必填	产物输出的根目录。	${CMAKE_BINARY_DIR}/output
   EXCLUDE_OPS	可选	需要排除生成的算子	Add、Conv2D

3. 使用生成的产物

   # 创建一个名为my_app的可执行文件，源文件为main.cpp
   add_executable(my_app main.cpp)
   # 将my_app可执行文件与es_math目标链接，PRIVATE表示依赖关系仅对my_app本身可见
   target_link_libraries(my_app PRIVATE es_math)

   

   因为ES构图API是基于算子IR原型生成，部分算子IR无法支撑所有信息表达（比如Conv类算子）或者IR表达有冗余信息（比如IdentityN算子），所以推荐用户自行封装ES API，该场景下用户可以自定义ES API，详细介绍请参见自定义ES API。

如下是一个完整的CMake文件示例，其中的CANN软件包安装路径/usr/local/Ascend/请根据实际情况进行替换，更多CMake示例请参见CMake常见示例。

# ===== 基础设置 =====
cmake_minimum_required(VERSION 3.17)
project(my_es_project LANGUAGES CXX)

# ===== 引入函数（推荐：使用 find_package） =====
list(APPEND CMAKE_MODULE_PATH "/usr/local/Ascend/cann/include/ge/cmake")
find_package(GenerateEsPackage REQUIRED)

# ===== 第一部分: 前置条件：定义原型库 =====
add_library(opgraph_math SHARED
)

# ===== 第二部分: 生成 ES API包 =====
add_es_library_and_whl(
    ES_LINKABLE_AND_ALL_TARGET es_math
    OPP_PROTO_TARGET  opgraph_math
    OUTPUT_PATH       ${CMAKE_BINARY_DIR}/output
)

# ===== 第三部分: 在应用中使用 =====
add_executable(my_app
    src/main.cpp
    src/inference.cpp
)

# 链接ES_LINKABLE_AND_ALL_TARGET
target_link_libraries(my_app PRIVATE
    es_math  # 自动获得依赖、头文件和库
)

构建命令为：

make my_app
# 输出：
# [Smart Build] Step 1: Building internal targets...
# [Smart Build] Found xx generated source file(s)
# [Smart Build] Step 2: Reconfiguring to include generated sources...
# [Smart Build] Step 3: Rebuilding with all generated sources...
# [Smart Build] Successfully built ES package 'es_math' with xx source file(s)
# Built target my_app

生成产物说明

• add_es_library_and_whl生成产物为：

  OUTPUT_PATH/
  ├── include/
  │   └── es_math/               # 头文件目录
  │       ├── es_math_ops.h      # C++接口聚合头文件，聚合头文件表示包含es_math下所有算子的构图API
  │       ├── es_math_ops_c.h    # C接口聚合头文件
  │       └── es_Add.h            # 单个算子头文件
  │       └── es_xxx.h            # 其他算子原型对应的ES构图头文件
  ├── lib64/
  │   └── libes_math.so          # 动态库
  └── whl/
      └── es_math-1.0.0-py3-none-any.whl  # Python包，用户使用Python语言构图时，需要手动安装该软件包

• add_es_library生成产物为：

  OUTPUT_PATH/
  ├── include/
  │   └── es_math/               # 头文件目录
  │       ├── es_math_ops.h      # C++接口聚合头文件
  │       ├── es_math_ops_c.h    # C接口聚合头文件
  │       └── es_Add.h           # 单个算子头文件
  │       └── es_xxx.h           # 其他算子原型对应的ES构图头文件
  └── lib64/
  │   └── libes_math.so          # 动态库
  └── whl/                        # C/C++场景下不会生成whl包，该目录为空

产物命名规则如下：