From e0e242974869eecc4751df3d5b755c6718b9af8d Mon Sep 17 00:00:00 2001 From: ZiWei Yuan Date: Sat, 15 Nov 2025 22:29:01 +0800 Subject: [PATCH] [ci]: update issue template & security & license (#1617) --- .github/ISSUE_TEMPLATE/-bug-.yaml | 90 ++++++----- .github/ISSUE_TEMPLATE/-bug2-.yaml | 39 ----- .github/ISSUE_TEMPLATE/-feature-.yaml | 62 +++++--- .github/ISSUE_TEMPLATE/-feature2-.yaml | 23 --- .github/SECURITY.md | 7 + LICENSE | 201 +++++++++++++++++++++++++ README_ZH.md | 3 +- 7 files changed, 302 insertions(+), 123 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/-bug2-.yaml delete mode 100644 .github/ISSUE_TEMPLATE/-feature2-.yaml create mode 100644 .github/SECURITY.md create mode 100644 LICENSE diff --git a/.github/ISSUE_TEMPLATE/-bug-.yaml b/.github/ISSUE_TEMPLATE/-bug-.yaml index 7c74c6e..a291c87 100644 --- a/.github/ISSUE_TEMPLATE/-bug-.yaml +++ b/.github/ISSUE_TEMPLATE/-bug-.yaml @@ -1,39 +1,55 @@ -name: 🐞 Bug report -description: Create a report to help us reproduce and fix the bug -title: "[Bug] " -labels: ['Bug'] - +name: "\U0001F41B Bug / help" +description: Create a report to help us improve the ktransformers project +labels: ["bug", "pending"] body: -- type: checkboxes - attributes: - label: Checklist - options: - - label: 1. I have searched related issues but cannot get the expected help. - - label: 2. The bug has not been fixed in the latest version. - - label: 3. Please note that if the bug-related issue you submitted lacks corresponding environment info and a minimal reproducible demo, it will be challenging for us to reproduce and resolve the issue, reducing the likelihood of receiving feedback. - - label: 4. If the issue you raised is not a bug but a question, please raise a discussion at https://github.com/kvcache-ai/ktransformers/discussions. Otherwise, it will be closed. - - label: 5. To help the community, I will use Chinese/English or attach an Chinese/English translation if using another language. Non-Chinese/English content without translation may be closed. + - type: markdown + attributes: + value: | + Issues included in **[FAQs](https://github.com/kvcache-ai/ktransformers/issues/1608)** or those with **insufficient** information may be closed without a response. + 已经包含在 **[常见问题](https://github.com/kvcache-ai/ktransformers/issues/1608)** 内或提供信息**不完整**的 issues 可能不会被回复。 -- type: textarea - attributes: - label: Describe the bug - description: A clear and concise description of what the bug is. - validations: - required: true -- type: textarea - attributes: - label: Reproduction - description: | - What command or script did you run? Which **model** are you using? - placeholder: | - A placeholder for the command. - validations: - required: true -- type: textarea - attributes: - label: Environment - description: | - Please provide necessary environment information here (e.g. OS/GPU/CPU). Otherwise the issue will be close. - placeholder: Environment here. - validations: - required: true \ No newline at end of file + - type: checkboxes + id: reminder + attributes: + label: Reminder + description: | + Please ensure you have read the above rules carefully and searched the existing issues (including FAQs). + 请确保您已经认真阅读了上述规则并且搜索过现有的 issues（包括常见问题）。 + + options: + - label: I have read the above rules and searched the existing issues. + required: true + + - type: textarea + id: system-info + validations: + required: true + attributes: + label: System Info + description: | + Please share your system info with us. You can run the command **lscpu**, ** nvidia-smi ** etc. and copy-paste its output below. + 请提供您的系统信息。您可以在命令行运行 **lscpu**, **nvidia-smi** 等命令，并将其输出复制到该文本框中。 + + placeholder: ktransformers version,sglang version, platform, python version, cpu info, GPU/NPU info ... + + - type: textarea + id: reproduction + validations: + required: true + attributes: + label: Reproduction + description: | + Please provide entry arguments, error messages and stack traces that reproduces the problem. + 请提供入口参数，错误日志以及异常堆栈以便于我们复现问题。 + + value: | + ```text + Put your message here. + ``` + + - type: textarea + id: others + validations: + required: false + attributes: + label: Others \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/-bug2-.yaml b/.github/ISSUE_TEMPLATE/-bug2-.yaml deleted file mode 100644 index 85b2180..0000000 --- a/.github/ISSUE_TEMPLATE/-bug2-.yaml +++ /dev/null @@ -1,39 +0,0 @@ -name: 🐞 BUG报告 -description: 创建报告以帮助我们复现并修复BUG -title: "[Bug] " -labels: ['Bug'] - -body: -- type: checkboxes - attributes: - label: 检查清单 - options: - - label: 1. 我已经搜索过相关问题，但未能获得预期的帮助 - - label: 2. 该问题在最新版本中尚未修复 - - label: 3. 请注意，如果您提交的BUG相关 issue 缺少对应环境信息和最小可复现示例，我们将难以复现和定位问题，降低获得反馈的可能性 - - label: 4. 如果您提出的不是bug而是问题，请在讨论区发起讨论 https://github.com/kvcache-ai/ktransformers/discussions。否则该 issue 将被关闭 - - label: 5. 为方便社区交流，我将使用中文/英文或附上中文/英文翻译（如使用其他语言）。未附带翻译的非中文/英语内容可能会被关闭 - -- type: textarea - attributes: - label: 问题描述 - description: 清晰简洁地描述BUG是什么 - validations: - required: true -- type: textarea - attributes: - label: 复现步骤 - description: | - 你运行了什么命令或脚本？使用的是哪个**模型**？ - placeholder: | - 在此处填写命令 - validations: - required: true -- type: textarea - attributes: - label: 环境信息 - description: | - 请提供必要的环境信息（如操作系统/GPU/CPU），否则该 issue 将被关闭 - placeholder: 在此处填写环境信息 - validations: - required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/-feature-.yaml b/.github/ISSUE_TEMPLATE/-feature-.yaml index 4ef23c4..9db7f26 100644 --- a/.github/ISSUE_TEMPLATE/-feature-.yaml +++ b/.github/ISSUE_TEMPLATE/-feature-.yaml @@ -1,23 +1,41 @@ -name: 🚀 Feature request -description: Suggest an idea for this project -title: "[Feature] " - +name: "\U0001F680 Feature request" +description: Submit a request for a new feature +labels: ["enhancement", "pending"] body: -- type: checkboxes - attributes: - label: Checklist - options: - - label: 1. If the issue you raised is not a feature but a question, please raise a discussion at https://github.com/kvcache-ai/ktransformers/discussions. Otherwise, it will be closed. - - label: 2. To help the community, I will use Chinese/English or attach an Chinese/English translation if using another language. Non-English/Chinese content without translation may be closed. -- type: textarea - attributes: - label: Motivation - description: | - A clear and concise description of the motivation of the feature. - validations: - required: true -- type: textarea - attributes: - label: Related resources - description: | - If there is an official code release or third-party implementations, please also provide the information here, which would be very helpful. \ No newline at end of file + - type: markdown + attributes: + value: | + Please do not create issues that are not related to new features under this category. + 请勿在此分类下创建和新特性无关的 issues。 + + - type: checkboxes + id: reminder + attributes: + label: Reminder + description: | + Please ensure you have read the above rules carefully and searched the existing issues. + 请确保您已经认真阅读了上述规则并且搜索过现有的 issues。 + + options: + - label: I have read the above rules and searched the existing issues. + required: true + + - type: textarea + id: description + validations: + required: true + attributes: + label: Description + description: | + A clear and concise description of the feature proposal. + 请详细描述您希望加入的新功能特性。 + + - type: textarea + id: contribution + validations: + required: false + attributes: + label: Pull Request + description: | + Have you already created the relevant PR and submitted the code? + 您是否已经创建了相关 PR 并提交了代码？ \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/-feature2-.yaml b/.github/ISSUE_TEMPLATE/-feature2-.yaml deleted file mode 100644 index 571af4a..0000000 --- a/.github/ISSUE_TEMPLATE/-feature2-.yaml +++ /dev/null @@ -1,23 +0,0 @@ -name: 🚀 新功能请求 -description: 为项目提出新功能建议 -title: "[Feature] " - -body: -- type: checkboxes - attributes: - label: 检查清单 - options: - - label: 1. 如果您提出的不是新功能而是问题，请在讨论区发起讨论 https://github.com/kvcache-ai/ktransformers/discussions。否则该 issue 将被关闭 - - label: 2. 为方便社区交流，我将使用中文/英文或附上英文/中文翻译（如使用其他语言）。未附带翻译的非英文/中文内容可能会被关闭 -- type: textarea - attributes: - label: 需求背景 - description: | - 清晰简洁地描述该功能的背景需求 - validations: - required: true -- type: textarea - attributes: - label: 相关资源 - description: | - 如果有官方代码实现或第三方实现，请在此提供相关信息，这将非常有帮助 \ No newline at end of file diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..25f69d6 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,7 @@ +# Reporting Security Issues + +To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/kvcache-ai/ktransformers/security/advisories/new) tab. + +We will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance. + +Report security bugs in third-party modules to the person or team maintaining the module. \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README_ZH.md b/README_ZH.md index 9c06802..20ddd72 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -8,7 +8,7 @@

一个用于体验尖端 LLM 推理/微调优化的灵活框架

- 🎯 概览 | 🚀 kt-kernel | 🎓 KT-SFT | 🔥 引用 | 💬 讨论 + 🎯 概览 | 🚀 kt-kernel | 🎓 KT-SFT | 🔥 引用 ## 🎯 概览 @@ -134,7 +134,6 @@ USE_KT=1 llamafactory-cli train examples/train_lora/deepseek3_lora_sft_kt.yaml ## 💬 社区与支持 - **GitHub Issues**：[报告问题或请求功能](https://github.com/kvcache-ai/ktransformers/issues) -- **GitHub Discussions**：[提问和分享想法](https://github.com/kvcache-ai/ktransformers/discussions) - **微信群**：请参见 [archive/WeChatGroup.png](./archive/WeChatGroup.png) ## 📦 KT原仓库