Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,61 @@
|
|
| 1 |
---
|
| 2 |
license: mit
|
|
|
|
|
|
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: mit
|
| 3 |
+
language:
|
| 4 |
+
- pl
|
| 5 |
---
|
| 6 |
+
|
| 7 |
+
## Model Overview
|
| 8 |
+
The model is a result of advanced fine-tuning methods applied to a base model, focusing on enhancing its capabilities for specific Polish language datasets. It incorporates cutting-edge techniques and is built upon the Zephyr Beta model framework.
|
| 9 |
+
|
| 10 |
+
## Current Status: Under Testing
|
| 11 |
+
- **Stage**: Alpha
|
| 12 |
+
- **Testing Phase**: Ongoing
|
| 13 |
+
- **Purpose**: To evaluate and refine the model's performance on specific tasks and datasets.
|
| 14 |
+
|
| 15 |
+
## Training Details
|
| 16 |
+
|
| 17 |
+
I trained the model using 3xRTX 3090 for 163 hours.
|
| 18 |
+
[](https://github.com/OpenAccess-AI-Collective/axolotl)
|
| 19 |
+
|
| 20 |
+
## Model Specifics
|
| 21 |
+
- **Base Model**: HuggingFaceH4/zephyr-7b-beta
|
| 22 |
+
- **Fine-Tuning Method**: QLORA
|
| 23 |
+
- **Primary Focus**: Polish language datasets
|
| 24 |
+
|
| 25 |
+
## Datasets:
|
| 26 |
+
- Dataset 1 Name: Lajonbot/alpaca-dolly-chrisociepa-instruction-only-polish
|
| 27 |
+
- Dataset 1 Link: [Lajonbot/alpaca-dolly-chrisociepa-instruction-only-polish](https://huggingface.co/datasets/Lajonbot/alpaca-dolly-chrisociepa-instruction-only-polish?row=16)
|
| 28 |
+
- Dataset 2 Name: klima7/polish-prose
|
| 29 |
+
- Dataset 2 Link: [klima7/polish-prose](https://huggingface.co/datasets/klima7/polish-prose)
|
| 30 |
+
|
| 31 |
+
## Usage Warning
|
| 32 |
+
As this is an experimental model, users should be aware of the following:
|
| 33 |
+
- **Reliability**: The model has not been fully tested and may exhibit unexpected behaviors or performance issues.
|
| 34 |
+
- **Updates**: The model is subject to change based on ongoing testing and feedback.
|
| 35 |
+
- **Data Sensitivity**: Users should exercise caution when using sensitive or private data, as the model's output and behavior are not fully predictable at this stage.
|
| 36 |
+
|
| 37 |
+
## Prompt template: Alpaca
|
| 38 |
+
|
| 39 |
+
```
|
| 40 |
+
Below is an instruction that describes a task. Write a response that appropriately completes the request.
|
| 41 |
+
|
| 42 |
+
### Instruction:
|
| 43 |
+
{prompt}
|
| 44 |
+
|
| 45 |
+
### Response:
|
| 46 |
+
|
| 47 |
+
```
|
| 48 |
+
|
| 49 |
+
## Demo
|
| 50 |
+
|
| 51 |
+
|
| 52 |
+
|
| 53 |
+
## Feedback and Contribution
|
| 54 |
+
User feedback is crucial during this testing phase. We encourage users to provide feedback on model performance, issues encountered, and any suggestions for improvements. Contributions in terms of shared test results, datasets, or code improvements are also welcome.
|
| 55 |
+
|
| 56 |
+
---
|
| 57 |
+
|
| 58 |
+
**Disclaimer**: This experimental model is provided 'as is', without warranty of any kind. Users should use the model at their own risk. The creators or maintainers of the model are not responsible for any consequences arising from its use.
|
| 59 |
+
|
| 60 |
+
|
| 61 |
+
|