From f6b8463b8d3677cd25a451602999b917c6e68b3a Mon Sep 17 00:00:00 2001
From: Michael Han <107991372+shimmyshimmer@users.noreply.github.com>
Date: Thu, 27 Mar 2025 00:26:18 -0700
Subject: [PATCH 01/18] Update README.md
---
README.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 90013bb084..423689bb54 100644
--- a/README.md
+++ b/README.md
@@ -317,12 +317,12 @@ trainer.train()
## 💡 Reinforcement Learning
-RL including DPO, GRPO, PPO, Reward Modelling, Online DPO all work with Unsloth. We're in 🤗Hugging Face's official docs! We're on the [SFT docs](https://huggingface.co/docs/trl/main/en/sft_trainer#accelerate-fine-tuning-2x-using-unsloth) and the [DPO docs](https://huggingface.co/docs/trl/main/en/dpo_trainer#accelerate-dpo-fine-tuning-using-unsloth)! List of RL notebooks:
+RL including DPO, GRPO, PPO, Reward Modelling, Online DPO all work with Unsloth. We're in 🤗Hugging Face's official docs! We're on the [GRPO docs](https://huggingface.co/learn/nlp-course/en/chapter12/6) and the [DPO docs](https://huggingface.co/docs/trl/main/en/dpo_trainer#accelerate-dpo-fine-tuning-using-unsloth)! List of RL notebooks:
- ORPO notebook: [Link](https://colab.research.google.com/github/unslothai/notebooks/blob/main/nb/Llama3_(8B)-ORPO.ipynb)
- DPO Zephyr notebook: [Link](https://colab.research.google.com/github/unslothai/notebooks/blob/main/nb/Zephyr_(7B)-DPO.ipynb)
-- KTO notebook: [Link](https://colab.research.google.com/drive/1a2b3c4d5e6f7g8h9i0j)
-- SimPO notebook: [Link](https://colab.research.google.com/drive/1a2b3c4d5e6f7g8h9i0j)
+- KTO notebook: [Link](https://colab.research.google.com/drive/1MRgGtLWuZX4ypSfGguFgC-IblTvO2ivM?usp=sharing)
+- SimPO notebook: [Link](https://colab.research.google.com/drive/1Hs5oQDovOay4mFA6Y9lQhVJ8TnbFLFh2?usp=sharing)
Click for DPO code
From 2cccc7a1a00554c91626268b89e183675f362de8 Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 14:58:21 -0700
Subject: [PATCH 02/18] Update issue templates
---
.github/ISSUE_TEMPLATE/bug_report.md | 42 +++++++++++++++++++++++
.github/ISSUE_TEMPLATE/custom.md | 10 ++++++
.github/ISSUE_TEMPLATE/documentation.md | 20 +++++++++++
.github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++
4 files changed, 92 insertions(+)
create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
create mode 100644 .github/ISSUE_TEMPLATE/custom.md
create mode 100644 .github/ISSUE_TEMPLATE/documentation.md
create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000000..bea0606c13
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,42 @@
+---
+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.
+## Issue Type
+
+## Steps to Reproduce
+
+1. **Environment Setup:**
+ - OS: [e.g., Ubuntu 20.04]
+ - Python Version: [e.g., 3.8.10]
+ - Frameworks/Libraries: past output of `pip freeze` here
+ - Colab / Script
+
+2. **Dataset Details:**
+ - Dataset Name:
+ - Data Preprocessing Steps: [e.g., Tokenization with specific parameters]
+
+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
+
+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:**
diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md
new file mode 100644
index 0000000000..48d5f81fa4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/custom.md
@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
new file mode 100644
index 0000000000..03891edaf1
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -0,0 +1,20 @@
+---
+name: Documentation
+about: Documentation request
+title: "[DOCUMENTATION]"
+labels: documentation
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000000..f3615edb5a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEAT]"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
From a7654887688648f49832a8f502498675290445a0 Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 14:59:15 -0700
Subject: [PATCH 03/18] Update and rename custom.md to documentation_request.md
---
.github/ISSUE_TEMPLATE/custom.md | 10 ------
.../ISSUE_TEMPLATE/documentation_request.md | 35 +++++++++++++++++++
2 files changed, 35 insertions(+), 10 deletions(-)
delete mode 100644 .github/ISSUE_TEMPLATE/custom.md
create mode 100644 .github/ISSUE_TEMPLATE/documentation_request.md
diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md
deleted file mode 100644
index 48d5f81fa4..0000000000
--- a/.github/ISSUE_TEMPLATE/custom.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-name: Custom issue template
-about: Describe this issue template's purpose here.
-title: ''
-labels: ''
-assignees: ''
-
----
-
-
diff --git a/.github/ISSUE_TEMPLATE/documentation_request.md b/.github/ISSUE_TEMPLATE/documentation_request.md
new file mode 100644
index 0000000000..c9fa21fac9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation_request.md
@@ -0,0 +1,35 @@
+---
+name: Documentation request
+about: Report incorrect or needed documentation to improve CUTLASS
+title: "[DOC]"
+labels: "? - Needs Triage, documentation"
+assignees: ''
+
+---
+
+## Report incorrect documentation
+
+**Location of incorrect documentation**
+Provide links and line numbers if applicable.
+
+**Describe the problems or issues found in the documentation**
+A clear and concise description of what you found to be incorrect.
+
+**Steps taken to verify documentation is incorrect**
+List any steps you have taken:
+
+**Suggested fix for documentation**
+Detail proposed changes to fix the documentation if you have any.
+
+---
+
+## Report needed documentation
+
+**Report needed documentation**
+A clear and concise description of what documentation you believe it is needed and why.
+
+**Describe the documentation you'd like**
+A clear and concise description of what you want to happen.
+
+**Steps taken to search for needed documentation**
+List any steps you have taken:
From 43d91745f0cadd123a62df19b1aed1142d2a546d Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 15:01:06 -0700
Subject: [PATCH 04/18] Update issue templates
---
.github/ISSUE_TEMPLATE/documentation.md | 20 -------------------
.../ISSUE_TEMPLATE/documentation_request.md | 4 ++--
2 files changed, 2 insertions(+), 22 deletions(-)
delete mode 100644 .github/ISSUE_TEMPLATE/documentation.md
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
deleted file mode 100644
index 03891edaf1..0000000000
--- a/.github/ISSUE_TEMPLATE/documentation.md
+++ /dev/null
@@ -1,20 +0,0 @@
----
-name: Documentation
-about: Documentation request
-title: "[DOCUMENTATION]"
-labels: documentation
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/documentation_request.md b/.github/ISSUE_TEMPLATE/documentation_request.md
index c9fa21fac9..062962deb5 100644
--- a/.github/ISSUE_TEMPLATE/documentation_request.md
+++ b/.github/ISSUE_TEMPLATE/documentation_request.md
@@ -1,8 +1,8 @@
---
name: Documentation request
-about: Report incorrect or needed documentation to improve CUTLASS
+about: Report incorrect or needed documentation to improve unsloth!
title: "[DOC]"
-labels: "? - Needs Triage, documentation"
+labels: documentation
assignees: ''
---
From f8a4812aa825b8d5489196585403f6e501b6e077 Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 15:02:50 -0700
Subject: [PATCH 05/18] Update issue templates
---
.github/ISSUE_TEMPLATE/custom.md | 10 ++++++++++
1 file changed, 10 insertions(+)
create mode 100644 .github/ISSUE_TEMPLATE/custom.md
diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md
new file mode 100644
index 0000000000..48d5f81fa4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/custom.md
@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+
From 3a7edad2dc0731882ab172a09bf28aaa66ef0f2b Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 15:03:39 -0700
Subject: [PATCH 06/18] Update custom.md
---
.github/ISSUE_TEMPLATE/custom.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md
index 48d5f81fa4..5aa2a672d2 100644
--- a/.github/ISSUE_TEMPLATE/custom.md
+++ b/.github/ISSUE_TEMPLATE/custom.md
@@ -1,10 +1,10 @@
---
-name: Custom issue template
-about: Describe this issue template's purpose here.
-title: ''
-labels: ''
+name: Submit question
+about: Ask a general question about CUTLASS
+title: "[QST]"
+labels: "? - Needs Triage, question"
assignees: ''
---
-
+**What is your question?**
From 37f85cb52019e2efc59b5a601ebb0dc1a3abb39c Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 15:08:38 -0700
Subject: [PATCH 07/18] add question template
---
.github/ISSUE_TEMPLATE/{custom.md => question.md} | 0
1 file changed, 0 insertions(+), 0 deletions(-)
rename .github/ISSUE_TEMPLATE/{custom.md => question.md} (100%)
diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/question.md
similarity index 100%
rename from .github/ISSUE_TEMPLATE/custom.md
rename to .github/ISSUE_TEMPLATE/question.md
From 48f8db80c06e18d9c77355e5c4de6dd700091bdc Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 15:11:00 -0700
Subject: [PATCH 08/18] fix template labels
---
.github/ISSUE_TEMPLATE/feature_request.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index f3615edb5a..a2956b5db2 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -2,7 +2,7 @@
name: Feature request
about: Suggest an idea for this project
title: "[FEAT]"
-labels: enhancement
+labels: feature request
assignees: ''
---
From 0b5366cb1f32f7220611cd140592a3d6f669576b Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 15:19:00 -0700
Subject: [PATCH 09/18] clean up bug template
---
.github/ISSUE_TEMPLATE/bug_report.md | 3 ---
1 file changed, 3 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index bea0606c13..d545c65917 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -9,9 +9,6 @@ assignees: ''
**Describe the bug**
A clear and concise description of what the bug is.
-## Issue Type
-
-## Steps to Reproduce
1. **Environment Setup:**
- OS: [e.g., Ubuntu 20.04]
From 0f7c8c43b7eca3b4c0d068c0ab5a253e4e7291cb Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 15:19:58 -0700
Subject: [PATCH 10/18] fix question template
---
.github/ISSUE_TEMPLATE/question.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
index 5aa2a672d2..0df891dacf 100644
--- a/.github/ISSUE_TEMPLATE/question.md
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -1,8 +1,8 @@
---
name: Submit question
-about: Ask a general question about CUTLASS
+about: Ask a general question about unsloth
title: "[QST]"
-labels: "? - Needs Triage, question"
+labels: "question"
assignees: ''
---
From 3f85b33fb012b47d7921a9c9f9051cc6a411c809 Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 15:21:47 -0700
Subject: [PATCH 11/18] generalize documentation template
---
.../{documentation_request.md => documentation.md} | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
rename .github/ISSUE_TEMPLATE/{documentation_request.md => documentation.md} (97%)
diff --git a/.github/ISSUE_TEMPLATE/documentation_request.md b/.github/ISSUE_TEMPLATE/documentation.md
similarity index 97%
rename from .github/ISSUE_TEMPLATE/documentation_request.md
rename to .github/ISSUE_TEMPLATE/documentation.md
index 062962deb5..45b53cb2e9 100644
--- a/.github/ISSUE_TEMPLATE/documentation_request.md
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -1,5 +1,5 @@
---
-name: Documentation request
+name: Documentation
about: Report incorrect or needed documentation to improve unsloth!
title: "[DOC]"
labels: documentation
From db1e94785ea71fcffbf19ba20a06eee74a333995 Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 15:34:01 -0700
Subject: [PATCH 12/18] more template edits
---
.github/ISSUE_TEMPLATE/bug_report.md | 2 +-
.github/ISSUE_TEMPLATE/feature_request.md | 10 ++--------
2 files changed, 3 insertions(+), 9 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index d545c65917..53b274aecc 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -14,7 +14,7 @@ A clear and concise description of what the bug is.
- OS: [e.g., Ubuntu 20.04]
- Python Version: [e.g., 3.8.10]
- Frameworks/Libraries: past output of `pip freeze` here
- - Colab / Script
+ - Colab / Script - was this run in colab or as a script?
2. **Dataset Details:**
- Dataset Name:
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index a2956b5db2..2651d3245f 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,6 +1,6 @@
---
name: Feature request
-about: Suggest an idea for this project
+about: Suggest an idea: new algorithm, model, kernel, etc.
title: "[FEAT]"
labels: feature request
assignees: ''
@@ -8,13 +8,7 @@ assignees: ''
---
**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+A clear and concise description of what you'd like to see in `unsloth`.
**Additional context**
Add any other context or screenshots about the feature request here.
From 633975aaa01a969858fa3956c1311317e57f1758 Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 15:36:45 -0700
Subject: [PATCH 13/18] make templates more concise
---
.github/ISSUE_TEMPLATE/documentation.md | 3 +++
.github/ISSUE_TEMPLATE/feature_request.md | 6 +++---
2 files changed, 6 insertions(+), 3 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
index 45b53cb2e9..0e9dc2fe88 100644
--- a/.github/ISSUE_TEMPLATE/documentation.md
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -7,6 +7,9 @@ assignees: ''
---
+- [ ] Report incorrect documentation
+- [ ] Report needed documentation
+
## Report incorrect documentation
**Location of incorrect documentation**
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 2651d3245f..7cae17fdb6 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -7,8 +7,8 @@ assignees: ''
---
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what you'd like to see in `unsloth`.
+**What features would you like to see? Is it related to a problem or a new feature you'd like to see? Please describe.**
+A clear and concise description of what we can do to improve `unsloth`.
**Additional context**
-Add any other context or screenshots about the feature request here.
+Add any other context or screenshots here.
From a645c8ff9900ae92de04bef137fdce33da5fcf89 Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 15:39:20 -0700
Subject: [PATCH 14/18] fix typos, better wording
---
.github/ISSUE_TEMPLATE/bug_report.md | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 53b274aecc..1448a746ce 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -13,12 +13,12 @@ A clear and concise description of what the bug is.
1. **Environment Setup:**
- OS: [e.g., Ubuntu 20.04]
- Python Version: [e.g., 3.8.10]
- - Frameworks/Libraries: past output of `pip freeze` here
- - Colab / Script - was this run in colab or as a script?
+ - 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 with specific parameters]
+ - Data Preprocessing Steps: [e.g., tokenization, formatting funcs, data collators, etc.]
3. **Model Details:**
- Model ID:
@@ -29,11 +29,13 @@ A clear and concise description of what the bug is.
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
From c37750ef742509f1878afaf3cd0526f2b906a074 Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 15:46:25 -0700
Subject: [PATCH 15/18] more edits
---
.github/ISSUE_TEMPLATE/documentation.md | 19 ++++++++-----------
1 file changed, 8 insertions(+), 11 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
index 0e9dc2fe88..20f94e224b 100644
--- a/.github/ISSUE_TEMPLATE/documentation.md
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -12,27 +12,24 @@ assignees: ''
## Report incorrect documentation
-**Location of incorrect documentation**
-Provide links and line numbers if applicable.
+**Location of incorrect documentation -- provide links and line numbers if possible.**
**Describe the problems or issues found in the documentation**
-A clear and concise description of what you found to be incorrect.
**Steps taken to verify documentation is incorrect**
List any steps you have taken:
-**Suggested fix for documentation**
-Detail proposed changes to fix the documentation if you have any.
+**Suggested fix**
---
## Report needed documentation
-**Report needed documentation**
-A clear and concise description of what documentation you believe it is needed and why.
+**What's missing?**
-**Describe the documentation you'd like**
-A clear and concise description of what you want to happen.
-**Steps taken to search for needed documentation**
-List any steps you have taken:
+**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.
From c366af7c2bbc80007ded1dc54049ad1da55790c0 Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 15:47:33 -0700
Subject: [PATCH 16/18] improve wording
---
.github/ISSUE_TEMPLATE/feature_request.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 7cae17fdb6..b64d7b90b7 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -8,7 +8,7 @@ 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.**
-A clear and concise description of what we can do to improve `unsloth`.
+A clear and concise description of what we can do to improve `unsloth`!
**Additional context**
Add any other context or screenshots here.
From e43fafb9c814c8251ebf3f34dbb6c7f119bcb6a4 Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Sun, 30 Mar 2025 15:52:31 -0700
Subject: [PATCH 17/18] make wording more user-friendly
---
.github/ISSUE_TEMPLATE/bug_report.md | 4 ++--
.github/ISSUE_TEMPLATE/documentation.md | 1 -
.github/ISSUE_TEMPLATE/feature_request.md | 4 ++--
3 files changed, 4 insertions(+), 5 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 1448a746ce..cf4f07a9bf 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -8,13 +8,13 @@ assignees: ''
---
**Describe the bug**
-A clear and concise description of what the bug is.
+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?
+ - `colab` / script - was this run in `colab` or as a script?
2. **Dataset Details:**
- Dataset Name:
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
index 20f94e224b..b8833510f4 100644
--- a/.github/ISSUE_TEMPLATE/documentation.md
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -17,7 +17,6 @@ assignees: ''
**Describe the problems or issues found in the documentation**
**Steps taken to verify documentation is incorrect**
-List any steps you have taken:
**Suggested fix**
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index b64d7b90b7..d9325c0f80 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -8,7 +8,7 @@ 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.**
-A clear and concise description of what we can do to improve `unsloth`!
+What we can do to improve `unsloth`?
**Additional context**
-Add any other context or screenshots here.
+Feel free to add any other context, links, or screenshots here.
\ No newline at end of file
From 13cf5b35afad3fb02cb6bb9f21b04aacbb248898 Mon Sep 17 00:00:00 2001
From: jeromeku
Date: Mon, 31 Mar 2025 12:28:44 -0700
Subject: [PATCH 18/18] Fix feature_request ISSUE_TEMPLATE
---
.github/ISSUE_TEMPLATE/feature_request.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index d9325c0f80..f6f78c0841 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,8 +1,8 @@
---
name: Feature request
-about: Suggest an idea: new algorithm, model, kernel, etc.
+about: "Suggest an idea: new algorithm, model, kernel, etc."
title: "[FEAT]"
-labels: feature request
+labels: "feature request"
assignees: ''
---
@@ -11,4 +11,4 @@ assignees: ''
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
+Feel free to add any other context, links, or screenshots here.