Skip to content

PTQ-Level Efficiency, QAT-Level Accuracy | 训练后量化的效率,量化感知训练的精度

Add issue templates and PR template with required fields (#1309)

Copiloteaf5885ab7aa
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..b5b1f0ac5
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,63 @@
+name: Bug Report
+description: Report a bug or issue with AutoRound
+title: "[Bug]: "
+labels: ["bug"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thank you for taking the time to report a bug! Please fill out the following sections to help us understand and fix the issue.
+
+ - type: textarea
+ id: problem-description
+ attributes:
+ label: Problem Description
+ description: Please provide a clear and detailed description of the problem you're experiencing.
+ placeholder: Describe what went wrong, what you expected to happen, and what actually happened.
+ validations:
+ required: true
+
+ - type: textarea
+ id: reproduction-steps
+ attributes:
+ label: Reproduction Steps
+ description: Please provide detailed steps to reproduce the issue.
+ placeholder: |
+ 1. Run command '...'
+ 2. Use model '...'
+ 3. Set parameters '...'
+ 4. See error
+ validations:
+ required: true
+
+ - type: textarea
+ id: environment
+ attributes:
+ label: Environment Information
+ description: Please provide information about your environment
+ placeholder: |
+ - OS: [e.g. Ubuntu 22.04]
+ - Python version: [e.g. 3.10]
+ - AutoRound version: [e.g. 0.9.5]
+ - Hardware: [e.g. CPU/GPU model]
+ validations:
+ required: false
+
+ - type: textarea
+ id: error-logs
+ attributes:
+ label: Error Logs
+ description: If applicable, please paste any error messages or logs
+ placeholder: Paste error logs here
+ render: shell
+ validations:
+ required: false
+
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Additional Context
+ description: Add any other context about the problem here (e.g., related issues, potential solutions)
+ placeholder: Any additional information that might be helpful
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..94255b3c8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+ - name: Documentation
+ url: https://github.com/intel/auto-round/blob/main/docs/step_by_step.md
+ about: Please check the documentation for usage instructions
+ - name: Community Discussion
+ url: https://github.com/intel/auto-round/discussions
+ about: Ask questions and discuss with the community
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 000000000..cd0d8ebc4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,59 @@
+name: Feature Request
+description: Suggest a new feature or improvement for AutoRound
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thank you for suggesting a new feature! Please fill out the following sections to help us understand your request.
+
+ - type: textarea
+ id: feature-description
+ attributes:
+ label: Feature Description
+ description: Please provide a clear and detailed description of the feature you'd like to see.
+ placeholder: Describe the feature and how it would work.
+ validations:
+ required: true
+
+ - type: textarea
+ id: motivation
+ attributes:
+ label: Motivation and Use Case
+ description: Why would this feature be useful? What problem does it solve?
+ placeholder: Explain the motivation behind this feature request and provide use cases.
+ validations:
+ required: true
+
+ - type: textarea
+ id: alternatives
+ attributes:
+ label: Alternatives Considered
+ description: Have you considered any alternative solutions or workarounds?
+ placeholder: Describe any alternative solutions or features you've considered.
+ validations:
+ required: false
+
+ - type: textarea
+ id: definition-of-done
+ attributes:
+ label: Definition of Done
+ description: Define the criteria that determine when this feature is complete. What needs to be implemented, tested, or documented?
+ placeholder: |
+ - [ ] Feature implemented and working as described
+ - [ ] Unit tests added/updated
+ - [ ] Documentation updated
+ - [ ] Performance impact assessed
+ - [ ] Example usage provided
+ validations:
+ required: false
+
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Additional Context
+ description: Add any other context, screenshots, or examples about the feature request here.
+ placeholder: Any additional information that might be helpful
+ validations:
+ required: false
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000000000..ca058cb6f
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,55 @@
+## Description
+
+<!-- Please provide a clear and concise description of what this PR does -->
+
+## Type of Change
+
+<!-- Please check the relevant option(s) -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Performance improvement
+- [ ] Code refactoring
+- [ ] Other (please describe):
+
+## Related Issues
+
+<!-- Link to related issues using #issue_number -->
+
+Fixes #
+Relates to #
+
+## Changes Made
+
+<!-- Please describe the changes made in detail -->
+
+-
+-
+-
+
+## Testing
+
+<!-- Describe the testing you have performed -->
+
+- [ ] Tested locally
+- [ ] Added/updated unit tests
+- [ ] All existing tests pass
+- [ ] Tested on specific hardware/environment (please specify):
+
+## Checklist
+
+<!-- Please check all applicable items -->
+
+- [ ] My code follows the project's coding style
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have updated the documentation accordingly
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+
+## Additional Context
+
+<!-- Add any other context, screenshots, or information about the PR here -->