From b657f8a18ee739045c579c6db956b20353362d2b Mon Sep 17 00:00:00 2001 From: wangjiacheng Date: Mon, 20 Oct 2025 14:04:58 +0800 Subject: [PATCH] add issue template --- .gitee/ISSUE_TEMPLATE/100-documentation.yml | 22 +++++ .gitee/ISSUE_TEMPLATE/200-installation.yml | 39 +++++++++ .gitee/ISSUE_TEMPLATE/300-bug-report.yml | 81 +++++++++++++++++++ .gitee/ISSUE_TEMPLATE/400-feature-request.yml | 31 +++++++ .gitee/ISSUE_TEMPLATE/500-RFC.yml | 45 +++++++++++ .gitee/ISSUE_TEMPLATE/600-usage.yml | 35 ++++++++ .gitee/ISSUE_TEMPLATE/config.yml | 5 ++ 7 files changed, 258 insertions(+) create mode 100644 .gitee/ISSUE_TEMPLATE/100-documentation.yml create mode 100644 .gitee/ISSUE_TEMPLATE/200-installation.yml create mode 100644 .gitee/ISSUE_TEMPLATE/300-bug-report.yml create mode 100644 .gitee/ISSUE_TEMPLATE/400-feature-request.yml create mode 100644 .gitee/ISSUE_TEMPLATE/500-RFC.yml create mode 100644 .gitee/ISSUE_TEMPLATE/600-usage.yml create mode 100644 .gitee/ISSUE_TEMPLATE/config.yml diff --git a/.gitee/ISSUE_TEMPLATE/100-documentation.yml b/.gitee/ISSUE_TEMPLATE/100-documentation.yml new file mode 100644 index 00000000..9cc19d26 --- /dev/null +++ b/.gitee/ISSUE_TEMPLATE/100-documentation.yml @@ -0,0 +1,22 @@ +name: 📚 Documentation +description: 如您在阅读[TorchAir资料](https://www.hiascend.com/document/detail/zh/Pytorch/710/modthirdparty/torchairuseguide)时遇到问题，请提交issue反馈。 +title: "[Doc]: " +labels: ["documentation"] + +body: + - type: textarea + attributes: + label: 📚 资料 issue + description: > + 清晰简明地描述资料中哪些内容存在问题。并附上资料连接。 + validations: + required: true + - type: textarea + attributes: + label: 建议一个潜在的替代/修复方案 + description: > + 请告诉我们在这方面应如何改进文档。 + - type: markdown + attributes: + value: > + 感谢您的贡献 🎉! diff --git a/.gitee/ISSUE_TEMPLATE/200-installation.yml b/.gitee/ISSUE_TEMPLATE/200-installation.yml new file mode 100644 index 00000000..69cfe271 --- /dev/null +++ b/.gitee/ISSUE_TEMPLATE/200-installation.yml @@ -0,0 +1,39 @@ +name: 🛠️ Installation +description: 安装过程中遇到错误时，请在此提交问题。 +title: "[Installation]: " +labels: ["installation"] + +body: + - type: markdown + attributes: + value: > + #### 在提交问题之前，请通过[搜索现有和历史问题](https://gitee.com/ascend/torchair/issues)确保该问题尚未被提出并解决。 + - type: textarea + attributes: + label: 您的环境信息 + description: | + 请提供以下信息 + value: | + ```text + -- CANN 版本 (e.g., CANN 3.0.x，5.x.x): + -- Pytorch/Torch_npu 版本 (e.g., v2.1.0, v2.6.0): + -- Python 版本 (e.g., Python 3.7.5): + -- 操作系统版本 (e.g., Ubuntu 18.04): + ``` + validations: + required: true + - type: textarea + attributes: + label: 您是如何编译、安装TorchAir的 + description: | + 请粘贴您尝试执行的完整命令。 + value: | + ```sh + git clone https://gitee.com/ascend/torchair.git + cd torchair + bash build.sh -i + ``` + - type: markdown + attributes: + value: > + 感谢您的贡献 🎉! \ No newline at end of file diff --git a/.gitee/ISSUE_TEMPLATE/300-bug-report.yml b/.gitee/ISSUE_TEMPLATE/300-bug-report.yml new file mode 100644 index 00000000..03ec25d6 --- /dev/null +++ b/.gitee/ISSUE_TEMPLATE/300-bug-report.yml @@ -0,0 +1,81 @@ +--- +name: 🐛 Bug report +description: 如果您发现Bug，请在此提交问题。 +title: "[Bug]: " +labels: + - bug +body: + - type: markdown + attributes: + value: > + #### 在提交问题之前，请通过[搜索现有和历史问题](https://gitee.com/ascend/torchair/issues)确保该问题尚未被提出并解决。 + - type: textarea + attributes: + label: 您的环境信息 + description: | + 请提供以下信息 + value: | + ```text + -- CANN 版本 (e.g., CANN 3.0.x，5.x.x): + -- Pytorch/Torch_npu 版本 (e.g., v2.1.0, v2.6.0): + -- Python 版本 (e.g., Python 3.7.5): + -- 操作系统版本 (e.g., Ubuntu 18.04): + ``` + validations: + required: true + - type: textarea + attributes: + label: 🐛 请描述bug + description: | + 请清晰简明地描述Bug的具体情况。 + + 若相关，请提供最小复现示例，以便我们通过运行代码重现错误。代码片段务必尽可能精简，请花时间删减无关代码，这能帮助我们高效调试。 + + 我们将直接复制您的代码，并期望得到与您相同的结果：请避免使用外部数据，并包含相关导入语句等。 + + + 请粘贴或描述您实际观察到的结果（而非预期结果）。若出现错误，请完整粘贴包含异常完整回溯的错误信息。建议将错误信息包裹在 ```三引号代码块中。 + + 请在示例中[开启python层日志](https://www.hiascend.com/document/detail/zh/Pytorch/710/modthirdparty/torchairuseguide/torchair_00008.html) + + 或者设置环境变量[开启c++层日志](https://www.hiascend.com/document/detail/zh/Pytorch/710/modthirdparty/torchairuseguide/torchair_00009.html) + + 以启用详细日志，协助调试潜在问题。 + + + 若遇到崩溃或卡死问题，请检查日志文件并指出具体崩溃或卡死的函数。 + + placeholder: | + 清晰简明地描述Bug的具体情况。 + + ```python + # 您的代码段，示例如下： + import torch + import torch_npu + import torchair as tng + + class Model(torch.nn.Module): + def __init__(self): + super().__init__() + + def forward(self, x, y, z): + return torch.add(x, y*z) + + model = Model() + + config = CompilerConfig() + npu_backend = tng.get_npu_backend(compiler_config=config) + torch.compile(model, backend=npu_backend) + model = torch.compile(model, backend=npu_backend, dynamic=False) + in1 = torch.randn(4, 1).float().npu() + in2 = torch.randn(4, 4).float().npu() + in3 = torch.randn(4, 4).int().npu() + graph_result = model(in1, in2, in3) + print(graph_result) + ``` + + ``` + 您收到的错误消息，包含完整的回溯信息。 + ``` + validations: + required: true \ No newline at end of file diff --git a/.gitee/ISSUE_TEMPLATE/400-feature-request.yml b/.gitee/ISSUE_TEMPLATE/400-feature-request.yml new file mode 100644 index 00000000..0be02a59 --- /dev/null +++ b/.gitee/ISSUE_TEMPLATE/400-feature-request.yml @@ -0,0 +1,31 @@ +name: 🚀 Feature request +description: 提交新的 TorchAir 功能提案/请求 +title: "[Feature]: " +labels: ["feature request"] + +body: + - type: markdown + attributes: + value: > + #### 在提交问题之前，请通过[搜索现有和历史问题](https://gitee.com/ascend/torchair/issues)确保该问题尚未被提出并解决。 + - type: textarea + attributes: + label: 🚀 特性说明、动机阐述与价值主张 + description: > + 清晰、准确地描述功能提案。请阐述提出该提案的动机。此功能请求是否与某个特定问题相关？例如："我正在处理 X 问题，并希望实现 Y 功能"。如果此请求与其他 TorchAir 问题相关，也请在此处添加链接。 + validations: + required: true + - type: textarea + attributes: + label: 替代解决方案 + description: > + 描述您考虑过的任何替代解决方案或功能（若有）。 + - type: textarea + attributes: + label: 何其他背景信息 + description: > + 请添加关于此功能请求的任何其他背景信息或截图。 + - type: markdown + attributes: + value: > + 感谢您的贡献 🎉! \ No newline at end of file diff --git a/.gitee/ISSUE_TEMPLATE/500-RFC.yml b/.gitee/ISSUE_TEMPLATE/500-RFC.yml new file mode 100644 index 00000000..2bde2fdd --- /dev/null +++ b/.gitee/ISSUE_TEMPLATE/500-RFC.yml @@ -0,0 +1,45 @@ +name: 💬 Request for comments (RFC). +description: 针对重大的架构变更或设计决策，现征求反馈意见。 +title: "[RFC]: " +labels: ["RFC"] + +body: + - type: markdown + attributes: + value: > + #### 请参考之前的 [RFCs]((https://gitee.com/ascend/torchair/issues))以供参考。 + - type: textarea + attributes: + label: 动机。 + description: > + RFC 的动机。 + validations: + required: true + - type: textarea + attributes: + label: 所提议的变更内容。 + description: > + 此 RFC 所提议的变更内容。 + validations: + required: true + - type: textarea + attributes: + label: 反馈周期。 + description: > + 此 RFC 的反馈周期。通常建议至少持续一周。 + validations: + required: false + - type: textarea + attributes: + label: 抄送列表。 + description: > + 您希望抄送的人员列表。 + validations: + required: false + - type: textarea + attributes: + label: 其他事项。 + description: > + 您想提及的任何其他事项。 + validations: + required: false \ No newline at end of file diff --git a/.gitee/ISSUE_TEMPLATE/600-usage.yml b/.gitee/ISSUE_TEMPLATE/600-usage.yml new file mode 100644 index 00000000..40520106 --- /dev/null +++ b/.gitee/ISSUE_TEMPLATE/600-usage.yml @@ -0,0 +1,35 @@ +name: 💻 Usage +description: 如果您不知道如何在昇腾（Ascend）上使用 TorchAir，请在此处提交问题。 +title: "[Usage]: " +labels: ["usage"] + +body: + - type: markdown + attributes: + value: > + #### 在提交问题之前，请通过[搜索现有和历史问题](https://gitee.com/ascend/torchair/issues)确保该问题尚未被提出并解决。 + - type: textarea + attributes: + label: 您的环境信息 + description: | + 请提供以下信息 + value: | + ```text + -- CANN 版本 (e.g., CANN 3.0.x，5.x.x): + -- Pytorch/Torch_npu 版本 (e.g., v2.1.0, v2.6.0): + -- Python 版本 (e.g., Python 3.7.5): + -- 操作系统版本 (e.g., Ubuntu 18.04): + ``` + validations: + required: true + - type: textarea + attributes: + label: 您希望如何在昇腾（Ascend）上使用 TorchAir？ + description: | + 请详细描述您希望如何在昇腾（Ascend）上使用 TorchAir。 + value: | + 我想使用xxx功能，但是我不知道如何使用。 + - type: markdown + attributes: + value: > + 感谢您的贡献 🎉! diff --git a/.gitee/ISSUE_TEMPLATE/config.yml b/.gitee/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..44d2a27a --- /dev/null +++ b/.gitee/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: TorchAir Questions + url: https://gitee.com/ascend/torchair/issues + about: 提问并与其他TorchAir社区成员一起交流 \ No newline at end of file -- Gitee