文档贡献指南【免费下载链接】ops-cv本项目是CANN提供的图像处理、目标检测相关的算子库实现网络在NPU上加速计算。项目地址: https://gitcode.com/cann/ops-cv欢迎您对本项目文档做出贡献优质的文档对于项目成功至关重要。本指南将帮助您高效地提交符合规范的文档。贡献范围我们欢迎任何能提升文档质量的贡献包括但不限于纠错与改进修复错别字、语法错误、错误的代码示例、过时的信息或失效的链接。澄清与优化让描述更清晰易懂优化语句结构补充背景知识。内容补充为现有功能添加使用示例、API文档、常见问题解答FAQ、最佳实践或警告说明等。新内容创作为新增功能撰写全新的章节或教程比如算子README、API介绍文档等如有问题建议先创建Issue讨论。本地化翻译帮助我们翻译或校对其他语言的文档。样式与导航改进文档网站的布局、可读性和导航结构。贡献流程准备工作确定任务如有文档问题可新建Issues建议标签类别[Documentation|文档反馈]并提供详细描述。基于已有Issues列表确定待解决的文档issue。认领任务在对应的Issue下评论/assign yourself表明您将处理它避免重复劳动。文档修改选择分支请从master或其他Tag分支下载源码到本地。遵循格式本项目推荐使用Markdown格式。遵循项目既有的写作风格。图片等静态资源放入对应目录例如图片一般在docs目录下figures文件夹特殊情况可自行调整。谨慎增删修改内容时请尽量保持原有的行宽和换行约定。提交更改原子化提交每个提交应专注于一个独立的修改。例如“修复xx指南的拼写错误”和“更新API参考的示例代码”应分两次提交。撰写清晰的提交信息简短说明不超过50字符 如有必要在此处进行更详细描述。说明修改的原因和内容而不是具体改了什么代码本身会展示。 关联的 Issue: #123发起Pull Request目标分支请将PR合并到项目的目标分支。标题与描述PR标题应清晰概括修改例如[Docs] 修复快速入门中的配置示例。PR描述详细说明您的更改内容、动机并关联对应Issue使用Closes #123或Fixes #456。预览检查请提前检查本地或在线浏览的文档效果确保渲染符合预期。等待审查维护者会进行审查可能会提出修改建议。请及时跟进讨论。写作规范开发者进行项目文档写作前请务必先阅读如下规范如有问题欢迎您随时提出建议前提条件请先学习CANN组织提供的统一写作规范具体参见CANN文档写作规范。文档内容要求介绍项目里必选和可选文档交付件。目录结构规范介绍目录划分的原则例如中、英文管理等。内容元素规范介绍不同写作元素的规则例如文件命名、标题、字体、图片、代码块、链接等。注意事项除了上述写作规则还需注意以下事项语气使用友好、专业且中立的语气。面向新手避免不必要的行话。术语保持术语一致性如统一使用“点击”而非“单击”。请参考项目术语表如有。代码示例确保所有代码示例可运行并经过测试。提供足够的上下文和解释。注明代码运行所需的环境或前提条件。标点与格式中英文混排时使用全角标点标点符号必须符合中/英文语境。标题使用合适的层级#、 ##、 ###。使用列表和表格来组织复杂信息。链接使用描述性链接文本避免“点击这里”确保链接资源真实可靠。图片常用格式推荐png格式风格尽量与已有图片保持一致。分辨率与清晰度需清晰且尺寸适中避免模糊或过度压缩。文件大小单张图片不建议超过10M。版权所有引用的图片、文献等资源请确保合规性。获取帮助如果您在贡献过程中有任何疑问查阅现有文档模板或规范有问题请先查阅项目已有的指南、API文档或README等。发起讨论您可以新建Issue或直接在相关Issue或PR中留言。算子README模板针对experimental新贡献算子算子README是必备文档交付件您可以参考本节提供的简单模板也支持您基于本模板进行内容拓展。文档格式推荐Markdown文件格式支持使用原生或Html语法请确保所有语法须符合官方规范。文档作用阐述清楚算子功能、实现原理、参数规格以及算子调用方式等。章节标题优先使用模板章节名如功能说明、参数说明等标题层级为##如有特殊情况层级请按序增加。支持章节自定义拓展可选章节视情况呈现。内容要求每章内容写作目标、写作规范请参考下文详细描述为方便理解将以AddExample算子README为例。产品支持情况写作规范推荐表格形式罗列支持的产品型号并打√产品形态介绍请参见昇腾产品形态说明。产品是否支持Atlas A3 训练系列产品/Atlas A3 推理系列产品√Atlas A2 训练系列产品/Atlas A2 推理系列产品√功能说明[!NOTE]写作目标阐明算子功能、计算原理、参数规格、调用方式、使用场景等。写作规范推荐无序列表形式一般包括如下维度算子功能必选请以一句话形式简洁明了阐述功能。计算公式可选复杂功能可借助公式介绍算子实现原理或不同场景下的计算过程。其他维度可选支持无序列表拓展请根据实际情况自定义比如计算示例、流程图等。算子功能完成张量加法计算。计算公式 $$ y x1 x2 $$参数说明[!NOTE]写作目标阐明算子定义的参数含义、作用、规格等信息。写作规范采用表格形式一般包括如下维度参数名解释算子定义文件中的参数顺序保持一致例如op_host/add_example_def.cpp或op_graph/add_example_proto.h。输入/输出/属性明确参数定位默认是必选若为可选一般为可选输入/可选输出/可选属性。描述提供参数含义、功能、使用场景等介绍包括与上述公式变量的映射关系。数据类型参数支持的data type张量数据类型一般为DT_XXX形式。为方便写作可不带DT_前缀。数据格式参数支持的数据排布方式张量format一般为FORMAT_xxx形式。为方便写作可不带FORMAT_前缀。其他维度可选支持表格字段扩展请根据实际情况自定义比如shape规格等。参数名输入/输出/属性描述数据类型数据格式x1输入表示add_example计算的第一个张量即公式中x1。FLOAT、FLOAT16、INT32NDx2输入表示add_example计算的第二个张量即公式中x2。数据类型与x1保持一致NDy输出表示add_example计算结果张量即公式中y。FLOAT、FLOAT16、INT32ND约束说明可选[!NOTE]写作目标 阐明算子使用过程中的注意事项例如参数组合约束、适用场景、对业务影响、算子性能或精度等。写作规范本章为可选若无约束可不呈现本章内容若有请采用无序列表形式。无调用说明[!NOTE]写作目标 提供算子调用方法尽量是可直接拷贝运行的示例代码方便快速验证。写作规范推荐表格形式如果内容复杂可采用其他形式。调用方式支持aclnn、图模式等方式调用也支持您自定义请提供至少一种方式。样例代码请在算子的examples目录提供调用示例代码例如examples/test_aclnn_add_example.cpp。文件命名规则为test_${invoke_mode}_${op_name}${invoke_mode}表示调用方式${op_name}表示算子名。说明不同调用方式的补充说明例如调用场景、调用原理、编译运行指导等请根据实际情况自定义。调用方式调用样例说明aclnn调用test_aclnn_add_example参见算子调用完成算子编译和验证。图模式调用test_geir_add_example参考资源可选[!NOTE]写作目标 提供除算子功能、规格、调用外的其他补充介绍例如算子设计文档Tiling/Kernel设计、参考文献等。写作规范本章为可选若无约束可不呈现本章内容若有请采用无序列表形式。无【免费下载链接】ops-cv本项目是CANN提供的图像处理、目标检测相关的算子库实现网络在NPU上加速计算。项目地址: https://gitcode.com/cann/ops-cv创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
CANN ops-cv文档贡献指南
文档贡献指南【免费下载链接】ops-cv本项目是CANN提供的图像处理、目标检测相关的算子库实现网络在NPU上加速计算。项目地址: https://gitcode.com/cann/ops-cv欢迎您对本项目文档做出贡献优质的文档对于项目成功至关重要。本指南将帮助您高效地提交符合规范的文档。贡献范围我们欢迎任何能提升文档质量的贡献包括但不限于纠错与改进修复错别字、语法错误、错误的代码示例、过时的信息或失效的链接。澄清与优化让描述更清晰易懂优化语句结构补充背景知识。内容补充为现有功能添加使用示例、API文档、常见问题解答FAQ、最佳实践或警告说明等。新内容创作为新增功能撰写全新的章节或教程比如算子README、API介绍文档等如有问题建议先创建Issue讨论。本地化翻译帮助我们翻译或校对其他语言的文档。样式与导航改进文档网站的布局、可读性和导航结构。贡献流程准备工作确定任务如有文档问题可新建Issues建议标签类别[Documentation|文档反馈]并提供详细描述。基于已有Issues列表确定待解决的文档issue。认领任务在对应的Issue下评论/assign yourself表明您将处理它避免重复劳动。文档修改选择分支请从master或其他Tag分支下载源码到本地。遵循格式本项目推荐使用Markdown格式。遵循项目既有的写作风格。图片等静态资源放入对应目录例如图片一般在docs目录下figures文件夹特殊情况可自行调整。谨慎增删修改内容时请尽量保持原有的行宽和换行约定。提交更改原子化提交每个提交应专注于一个独立的修改。例如“修复xx指南的拼写错误”和“更新API参考的示例代码”应分两次提交。撰写清晰的提交信息简短说明不超过50字符 如有必要在此处进行更详细描述。说明修改的原因和内容而不是具体改了什么代码本身会展示。 关联的 Issue: #123发起Pull Request目标分支请将PR合并到项目的目标分支。标题与描述PR标题应清晰概括修改例如[Docs] 修复快速入门中的配置示例。PR描述详细说明您的更改内容、动机并关联对应Issue使用Closes #123或Fixes #456。预览检查请提前检查本地或在线浏览的文档效果确保渲染符合预期。等待审查维护者会进行审查可能会提出修改建议。请及时跟进讨论。写作规范开发者进行项目文档写作前请务必先阅读如下规范如有问题欢迎您随时提出建议前提条件请先学习CANN组织提供的统一写作规范具体参见CANN文档写作规范。文档内容要求介绍项目里必选和可选文档交付件。目录结构规范介绍目录划分的原则例如中、英文管理等。内容元素规范介绍不同写作元素的规则例如文件命名、标题、字体、图片、代码块、链接等。注意事项除了上述写作规则还需注意以下事项语气使用友好、专业且中立的语气。面向新手避免不必要的行话。术语保持术语一致性如统一使用“点击”而非“单击”。请参考项目术语表如有。代码示例确保所有代码示例可运行并经过测试。提供足够的上下文和解释。注明代码运行所需的环境或前提条件。标点与格式中英文混排时使用全角标点标点符号必须符合中/英文语境。标题使用合适的层级#、 ##、 ###。使用列表和表格来组织复杂信息。链接使用描述性链接文本避免“点击这里”确保链接资源真实可靠。图片常用格式推荐png格式风格尽量与已有图片保持一致。分辨率与清晰度需清晰且尺寸适中避免模糊或过度压缩。文件大小单张图片不建议超过10M。版权所有引用的图片、文献等资源请确保合规性。获取帮助如果您在贡献过程中有任何疑问查阅现有文档模板或规范有问题请先查阅项目已有的指南、API文档或README等。发起讨论您可以新建Issue或直接在相关Issue或PR中留言。算子README模板针对experimental新贡献算子算子README是必备文档交付件您可以参考本节提供的简单模板也支持您基于本模板进行内容拓展。文档格式推荐Markdown文件格式支持使用原生或Html语法请确保所有语法须符合官方规范。文档作用阐述清楚算子功能、实现原理、参数规格以及算子调用方式等。章节标题优先使用模板章节名如功能说明、参数说明等标题层级为##如有特殊情况层级请按序增加。支持章节自定义拓展可选章节视情况呈现。内容要求每章内容写作目标、写作规范请参考下文详细描述为方便理解将以AddExample算子README为例。产品支持情况写作规范推荐表格形式罗列支持的产品型号并打√产品形态介绍请参见昇腾产品形态说明。产品是否支持Atlas A3 训练系列产品/Atlas A3 推理系列产品√Atlas A2 训练系列产品/Atlas A2 推理系列产品√功能说明[!NOTE]写作目标阐明算子功能、计算原理、参数规格、调用方式、使用场景等。写作规范推荐无序列表形式一般包括如下维度算子功能必选请以一句话形式简洁明了阐述功能。计算公式可选复杂功能可借助公式介绍算子实现原理或不同场景下的计算过程。其他维度可选支持无序列表拓展请根据实际情况自定义比如计算示例、流程图等。算子功能完成张量加法计算。计算公式 $$ y x1 x2 $$参数说明[!NOTE]写作目标阐明算子定义的参数含义、作用、规格等信息。写作规范采用表格形式一般包括如下维度参数名解释算子定义文件中的参数顺序保持一致例如op_host/add_example_def.cpp或op_graph/add_example_proto.h。输入/输出/属性明确参数定位默认是必选若为可选一般为可选输入/可选输出/可选属性。描述提供参数含义、功能、使用场景等介绍包括与上述公式变量的映射关系。数据类型参数支持的data type张量数据类型一般为DT_XXX形式。为方便写作可不带DT_前缀。数据格式参数支持的数据排布方式张量format一般为FORMAT_xxx形式。为方便写作可不带FORMAT_前缀。其他维度可选支持表格字段扩展请根据实际情况自定义比如shape规格等。参数名输入/输出/属性描述数据类型数据格式x1输入表示add_example计算的第一个张量即公式中x1。FLOAT、FLOAT16、INT32NDx2输入表示add_example计算的第二个张量即公式中x2。数据类型与x1保持一致NDy输出表示add_example计算结果张量即公式中y。FLOAT、FLOAT16、INT32ND约束说明可选[!NOTE]写作目标 阐明算子使用过程中的注意事项例如参数组合约束、适用场景、对业务影响、算子性能或精度等。写作规范本章为可选若无约束可不呈现本章内容若有请采用无序列表形式。无调用说明[!NOTE]写作目标 提供算子调用方法尽量是可直接拷贝运行的示例代码方便快速验证。写作规范推荐表格形式如果内容复杂可采用其他形式。调用方式支持aclnn、图模式等方式调用也支持您自定义请提供至少一种方式。样例代码请在算子的examples目录提供调用示例代码例如examples/test_aclnn_add_example.cpp。文件命名规则为test_${invoke_mode}_${op_name}${invoke_mode}表示调用方式${op_name}表示算子名。说明不同调用方式的补充说明例如调用场景、调用原理、编译运行指导等请根据实际情况自定义。调用方式调用样例说明aclnn调用test_aclnn_add_example参见算子调用完成算子编译和验证。图模式调用test_geir_add_example参考资源可选[!NOTE]写作目标 提供除算子功能、规格、调用外的其他补充介绍例如算子设计文档Tiling/Kernel设计、参考文献等。写作规范本章为可选若无约束可不呈现本章内容若有请采用无序列表形式。无【免费下载链接】ops-cv本项目是CANN提供的图像处理、目标检测相关的算子库实现网络在NPU上加速计算。项目地址: https://gitcode.com/cann/ops-cv创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
