triton-npu-operator-doc-gen

Original：🇨🇳 Chinese
Translated

Generate interface documents for Triton operators of Ascend NPU. Used when users need to create or update interface documents for Triton operators of Ascend NPU. Core capabilities: (1) Generate standardized documents based on templates (2) Support the list of Ascend NPU product models (3) Provide specifications for operator parameter descriptions (4) Generate call example frameworks.

5installs
Sourceascend/agent-skills
Added on

NPX Install

npx skill4agent add ascend/agent-skills triton-npu-operator-doc-gen

Tags

Translated version includes tags in frontmatter
triton-operator-documentationascend-npudocument-generationtemplate-based-docsai-operator-interface

SKILL.md Content (Chinese)

View Translation Comparison →

Triton NPU Operator Interface Document Generator

Function Description

This Skill is used to generate standardized interface documents for Triton operators on the Ascend NPU platform. The generated documents follow the official Ascend document format, including product support status, function descriptions, function prototypes, parameter descriptions, constraints, and call examples.

Usage

Basic Usage

  1. Provide operator name and basic information
  2. Input the function description and calculation formula of the operator
  3. Provide function prototype and parameter descriptions
  4. Define constraints and supported data types
  5. Provide call example code

Document Structure Template

The generated document will include the following sections:
markdown
# {Operator Name}

[📄 View Source Code]({Source Code Link})

## Product Support Status

| Product             |  Supported  |
|:-------------------------|:----------:|
|  <term>Ascend 950PR/Ascend 950DT</term>   |     {Supported}    |
|  <term>Atlas A3 Training Series/Atlas A3 Inference Series</term>   |     {Supported}    |
|  <term>Atlas A2 Training Series/Atlas A2 Inference Series</term>     |     {Supported}    |
|  <term>Atlas 200I/500 A2 Inference Products</term>    |     {Supported}    |
|  <term>Atlas Inference Series</term>    |     {Supported}    |
|  <term>Atlas Training Series</term>    |     {Supported}    |

## Function Description

- Interface Function: {Detailed Operator Function Description}
- Calculation Formula:

  $$
  {LaTeX-formatted Calculation Formula}
  $$

## Function Prototype

  {Function Prototype}

## Parameter Description

  <table style="undefined;table-layout: fixed; width: 953px"><colgroup>
  <col style="width: 173px">
  <col style="width: 112px">
  <col style="width: 668px">
  </colgroup>
  <thead>
    <tr>
      <th>Parameter Name</th>
      <th>Input/Output</th>
      <th>Description</th>
    </tr></thead>
  <tbody>
    <tr>
      <td>{Parameter Name}</td>
      <td>{Input/Output}</td>
      <td>{Parameter Description}</td>
    </tr>
  </tbody>
  </table>

## Constraint Description

- Data type support for each platform:
  - <term>Atlas A2 Training Series/Atlas A2 Inference Series</term>, <term>Atlas A3 Training Series/Atlas A3 Inference Series</term>, <term>Ascend 950PR/Ascend 950DT</term>:
    | `{Parameter 1}` Data Type | `{Parameter 2}` Data Type | `{Parameter 3}` Data Type | `{Parameter 4}` Data Type |
    | -------- | -------- | -------- | -------- |
    | {Data Type 1} | {Data Type 2} | {Data Type 3} | {Data Type 4} |

## Call Example

```python
{Python Call Example Code}