diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..cf4f07a9bf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,41 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. Please fill out the following sections and provide a minimal reproduction script so that we can provide a solution as quickly as possible! + +1. **Environment Setup:** + - OS: [e.g., Ubuntu 20.04] + - Python Version: [e.g., 3.8.10] + - Frameworks/Libraries: please paste output of `pip freeze` here + - `colab` / script - was this run in `colab` or as a script? + +2. **Dataset Details:** + - Dataset Name: + - Data Preprocessing Steps: [e.g., tokenization, formatting funcs, data collators, etc.] + +3. **Model Details:** + - Model ID: + - Model Configuration: [e.g., lora params, quantization, etc.] + +4. **Training Configuration:** + - Trainer Args: `SFTConfig`, `GRPOConfig` + +5. **Reproduction Steps:** + - Minimal script to reproduce error + - If using a `colab`, please provide the link to the notebook and describe any changes made. + +6. **Expected Behavior:** + +7. **Actual Behavior:** + - [e.g., Description of the error, unexpected results, or performance issues encountered] + - [e.g., Error messages or logs] + +8. **Additional notes:** + - Any additional information that might help us reproduce the bug. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000000..b8833510f4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,34 @@ +--- +name: Documentation +about: Report incorrect or needed documentation to improve unsloth! +title: "[DOC]" +labels: documentation +assignees: '' + +--- + +- [ ] Report incorrect documentation +- [ ] Report needed documentation + +## Report incorrect documentation + +**Location of incorrect documentation -- provide links and line numbers if possible.** + +**Describe the problems or issues found in the documentation** + +**Steps taken to verify documentation is incorrect** + +**Suggested fix** + +--- + +## Report needed documentation + +**What's missing?** + + +**Describe the documentation you'd like -- how can we make using `unsloth` easier?** + + +**Help us understand how we can make finding the needed info easier!** +List any steps you have taken, e.g. searching the repo, reading the docs, etc. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..d9325c0f80 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: Feature request +about: Suggest an idea: new algorithm, model, kernel, etc. +title: "[FEAT]" +labels: feature request +assignees: '' + +--- + +**What features would you like to see? Is it related to a problem or a new feature you'd like to see? Please describe.** +What we can do to improve `unsloth`? + +**Additional context** +Feel free to add any other context, links, or screenshots here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000000..0df891dacf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,10 @@ +--- +name: Submit question +about: Ask a general question about unsloth +title: "[QST]" +labels: "question" +assignees: '' + +--- + +**What is your question?**