Sample Usage Guide

1. Function Description

This sample demonstrates graph construction using operator overload, aimed at helping graph developers quickly understand operator overload definition.

2. Directory Structure

cpp/
├── src/
|   └── CMakeLists.txt                  // CMake build file
|   └── es_showcase.h                   // Header file
|   └── make_add_sub_mul_div_graph.cpp  // sample file
|   └── make_add_graph.cpp              // sample file
├── CMakeLists.txt                      // CMake build file
├── main.cpp                            // Program main entry
|—— README.md                           // README file
├── run_sample.sh                       // Execution script
|—— utils.h                             // Utility file

3. Usage Instructions

3.1. Prepare CANN Package

• Install toolkit and ops packages correctly following Environment Preparation
• Set environment variables (assuming package is installed at /usr/local/Ascend/)

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

3.2. Build and Execute

Simply run the following command to clean, generate interfaces, construct graph and DUMP graph:

bash run_sample.sh

Current run_sample.sh behavior: automatically clean old build, build sample and default execute sample dump. When you see the following message, it indicates successful execution:

[Success] sample execution successful, pbtxt dump generated in current directory. The file starts with ge_onnx_ and can be opened in netron for display

Output File Description

After successful execution, the following files will be generated in current directory:

• ge_onnx_*.pbtxt - protobuf text format of graph structure, can be viewed with netron

Build Graph and Execute

Besides basic graph construction and dump functionality, esb_sample also supports building graph and actually executing computation.

bash run_sample.sh -t sample_and_run

This command will:

1. Automatically generate ES interfaces
2. Compile sample program
3. Generate dump graph, run graph and output computation results

After successful execution, you will see:

[Success] sample_and_run execution successful, pbtxt and data output dump generated in current directory

You can view computation results through data file

3.3. Log Printing

If you need log printing to assist debugging during executable program execution, you can set the following environment variables before bash run_sample.sh to print logs to screen:

export ASCEND_SLOG_PRINT_TO_STDOUT=1 # Print logs to screen
export ASCEND_GLOBAL_LOG_LEVEL=0     # Log level set to debug level

3.4. DUMP Graph During Graph Compilation Process

If you need to DUMP graph to assist debugging graph compilation process during executable program execution, you can set the following environment variables before bash run_sample.sh -t sample_and_run to DUMP graph to execution path:

export DUMP_GE_GRAPH=2

4. Core Concepts Introduction

4.1. Graph Construction Steps

• Create graph builder (provides context, workspace and construction-related methods needed for graph construction)
• Add starting nodes (starting nodes refer to nodes without input dependencies, usually including graph inputs (like Data nodes) and weight constants (like Const nodes))
• Add intermediate nodes (intermediate nodes are computation nodes with input dependencies, usually generated by user graph construction logic, and connected using existing nodes as inputs)
• Set graph output (explicitly specify graph output nodes as computation result endpoints)

4.2. Operator Overload

Concept Explanation: Operator overload is a syntax sugar provided by ES API, making graph construction code more concise and intuitive.

Graph Construction API Features:

• Operator overload maintains the same type checking and constraints as function calls