Project Documentation

English | 简体中文

Directory Structure

docs/
├── zh/api/              # Chinese API reference documentation
├── zh/guide/            # Chinese usage guides
├── zh/programming_model/ # Chinese programming model documentation
├── zh/compilation/      # Chinese build and third-party dependency documentation
├── zh/contributing/     # Chinese contribution guide
├── en/compilation/      # English build and third-party dependency documentation
├── en/contributing/     # English contribution guide
├── quick_start.md       # Quick start
└── quick_start_en.md    # English quick start

Document Index

Document	Content
Quick Start	Environment setup, source compilation, and UT verification for asc-comm.
Programming Model (Chinese)	Ascend C communication programming paradigm, abstract hardware architecture, and classification and selection of communication modes.
API Reference (Chinese)	List of currently published asc-comm interfaces.
Hcomm Usage Guide (Chinese)	Basic workflow for Hcomm point-to-point communication interfaces.
Build & Test	CANN environment, development run package, UT build, and sample build instructions.
Third-party Dependencies & Compatibility	Direct dependencies, sample runtime dependencies, installation configuration, and integration dependency boundaries.
API Documentation Contribution Guide	Structure, constraints, and checklist for adding or updating API documentation.
Documentation Contribution Guide	Specification for supplementing README, docs, examples, and other documentation.
Contribution Guide	Issue, development, check, and PR submission workflow.
Samples	Entry point for asc-comm API samples, including the AIV direct-drive URMA WriteNbi/ReadNbi point-to-point communication sample.