Sample Usage Guide

The example directory provides a series of Runtime interface samples, including Device management, Stream management, Event management, memory management, Kernel execution, and more. These samples are for developer reference to help developers quickly get started and master Runtime key features.

Directory Overview

0_quickstart: Quick start samples, using aclnnAdd vector addition as the entry point to demonstrate initialization configuration, Device/Stream creation, Tensor and DataBuffer management, workspace allocation, operator execution, synchronization waiting, and resource release processes.
1_basic_features: Basic feature samples, including device management (single-thread and multi-thread), memory management (memory copy, inter-process memory sharing, virtual memory management), Stream management (single-stream task dispatch, multi-stream task dispatch), and more.
2_advanced_features: Advanced feature samples, including operator Kernel loading and execution, ACL Graph, Reduce and random number generation built-in system task execution, Host-side callback function dispatch, and more.
3_memory_advanced: Advanced memory management samples, including custom memory allocator, Host memory registration, unified addressing, Stream memory operations, Stream ordered memory allocation, and more.
4_reliability: Reliability samples, including overflow detection, error recovery, and more.
5_performance: Performance analysis and precision debugging samples.
6_scenarios: Scenario-based samples, for typical scenarios such as training pipelines, multi-device inference, and fault-tolerant execution.

Environment Preparation

Before compiling and running samples, obtain and install the firmware, driver, and CANN software packages. For detailed steps, refer to the CANN Software Installation Guide.

If you have custom modifications to the source code in the src directory of this repository, after installing the CANN software, you also need to compile the source code and deploy it to the environment. For specific operations, refer to README.

Running Samples

Download the sample code and upload it to the environment where CANN software is installed. Switch to the sample directory.

# This example uses the basic memory sample
cd ${git_clone_path}/example/1_basic_features/memory/0_h2h_memory_copy

Set environment variables.

# Replace ${install_root} with the CANN installation root directory. The default installation is in the `/usr/local/Ascend` directory.
source ${install_root}/cann/set_env.sh
export ASCEND_INSTALL_PATH=${install_root}/cann

Run the following command to execute the sample.

# Note that some test cases have different run commands. Refer to the compile and run commands in the README.md file in each test case directory.
bash run.sh

Sample Code Description

All samples demonstrate typical usage patterns of CANN Runtime API.

Sample code is for learning and interface understanding.
To highlight core processes, some examples simplify engineering handling.
Before using in production environments, please add complete error handling, resource management, and boundary checking.