Update README.md
Browse files
README.md
CHANGED
|
@@ -1,22 +1,36 @@
|
|
| 1 |
-
---
|
| 2 |
-
language:
|
| 3 |
-
- en
|
| 4 |
-
license: apache-2.0
|
| 5 |
-
tags:
|
| 6 |
-
- text-generation-inference
|
| 7 |
-
- transformers
|
| 8 |
-
- unsloth
|
| 9 |
-
- mistral
|
| 10 |
-
- trl
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
|
|
|
|
|
|
| 15 |
|
| 16 |
- **Developed by:** eltaiefaymen
|
| 17 |
- **License:** apache-2.0
|
| 18 |
- **Finetuned from model :** unsloth/mistral-7b-bnb-4bit
|
| 19 |
|
| 20 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 21 |
|
| 22 |
-
[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
|
|
|
|
| 1 |
+
---
|
| 2 |
+
language:
|
| 3 |
+
- en
|
| 4 |
+
license: apache-2.0
|
| 5 |
+
tags:
|
| 6 |
+
- text-generation-inference
|
| 7 |
+
- transformers
|
| 8 |
+
- unsloth
|
| 9 |
+
- mistral
|
| 10 |
+
- trl
|
| 11 |
+
- python
|
| 12 |
+
base_model: unsloth/mistral-7b-bnb-4bit
|
| 13 |
+
---
|
| 14 |
+
|
| 15 |
+
# AI-DocGen Model
|
| 16 |
+
|
| 17 |
|
| 18 |
- **Developed by:** eltaiefaymen
|
| 19 |
- **License:** apache-2.0
|
| 20 |
- **Finetuned from model :** unsloth/mistral-7b-bnb-4bit
|
| 21 |
|
| 22 |
+
# Overview
|
| 23 |
+
This model, AI-DocGen, is a finetuned version of the unsloth/mistral-7b-bnb-4bit model. It has been specifically trained to generate docstrings for Python code snippets according to Python's docstring conventions.
|
| 24 |
+
|
| 25 |
+
# Features
|
| 26 |
+
- **Fast Finetuning:** The model was trained 2x faster using Unsloth and Huggingface's TRL library.
|
| 27 |
+
- **Optimized for Documentation:** Generates comprehensive and accurate docstrings for Python functions and classes.
|
| 28 |
+
- **Efficient Inference:** Supports 4-bit quantization for reduced memory usage and faster inference.
|
| 29 |
+
|
| 30 |
+
# Training Details
|
| 31 |
+
- **Base Model:** unsloth/mistral-7b-bnb-4bit
|
| 32 |
+
- **Training Library:** Huggingface's TRL
|
| 33 |
+
- **Training Framework:** Unsloth
|
| 34 |
+
|
| 35 |
|
| 36 |
+
[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
|