metadef

Latest News

[2025/12/26] The metadef project is first released.

Overview

metadef, namely Ascend Metadata Definition, defines relevant data structures and external interfaces.

Position in the CANN Architecture

metadef is a foundational component repository of the CANN (Compute Architecture for Neural Networks) platform. It provides shared base data structures and interfaces for upper-layer components such as ge (Graph Engine) and operator repositories (ops-nn, ops-math, ops-transformer, ops-cv).

flowchart TD
    App[Application Layer<br/>MindSpore, PyTorch, TensorFlow]
    subgraph Ops[Operator Repositories]
        OpsNN[ops-nn<br/>ops-math<br/>ops-transformer<br/>ops-cv]
    end
    GE[ge]
    Other[other components]
    MetaDef[metadef<br/>Base Library<br/>Shared base data structures and interfaces]

    App --> Ops
    App --> GE
    App --> Other
    Ops --> MetaDef
    GE --> MetaDef
    Other --> MetaDef

Core Features Provided by metadef

Feature	Description	Usage Scenario
Basic Data Types	Defines basic data structures such as Tensor, Shape, DataType, and Format	Graph compilation, operator development, runtime execution
Operator Registration Interface	Provides registration mechanisms for operator types, attributes, and Tiling functions	Developing custom operators
Execution Context	Provides context building interfaces for operator execution	Operator infrastructure development
Attribute/Type Definition	Defines common tools such as operator attributes and type utilities	Operator type inference, format conversion

When to Modify metadef?

Typically, developers do not need to directly modify the metadef repository, because:

ge and ops provide mature upper-layer interfaces: In most scenarios, developers can complete development through ge or ops interfaces.
ABI compatibility requirements: Interface changes in metadef must maintain ABI compatibility. Arbitrary modifications may cause other components to malfunction.

Typical scenarios requiring metadef modifications:

Adding common base types: When both ge and ops require a new base data type.
Extending operator registration capabilities: When new operator registration features need support.
Fixing common interface issues: When defects are found in base data types or interfaces.
Cross-repository collaboration requirements: When multiple components require a unified interface implementation.

Note: Before modifying metadef, ensure that you:

Verify the actual need in the ge or ops repository.

Evaluate the impact on other components.

Maintain ABI compatibility.

Thoroughly test dependent components.

Quick Start

To quickly build this project, visit Source Code Build to learn how to compile, install, and perform basic verification tests.

Learning Tutorials

Developer Guide

If you need to modify or extend metadef, follow these steps:

Development Process

graph LR
    A[Requirement Analysis<br/>From ge/ops common needs] --> B[Interface Design<br/>Maintain ABI compatibility]
    B --> C[Code Implementation<br/>inc/ header files]
    C --> D[Unit Testing<br/>tests directory]
    D --> E[Local Build Verification<br/>bash build.sh]
    E --> F[Submit PR<br/>Associate ge/ops verification]

Code Modification Checklist

Before submitting metadef modifications, ensure:

The modification originates from real requirements in ge or ops (not personal preference).
ABI compatibility of external interfaces is maintained.
Corresponding unit tests are added.
All tests pass (bash tests/run_test.sh -u).
Relevant documentation is updated (docs/api/README.md).
Commit message follows the Conventional Commits specification.

Detailed API Reference

For detailed information about all interfaces in this repository, visit API Reference.