Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,63 @@
|
|
| 1 |
---
|
| 2 |
license: cc-by-nc-sa-3.0
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: cc-by-nc-sa-3.0
|
| 3 |
+
language:
|
| 4 |
+
- it
|
| 5 |
+
pipeline_tag: text-generation
|
| 6 |
---
|
| 7 |
+
--------------------------------------------------------------------------------------------------
|
| 8 |
+
|
| 9 |
+
<body>
|
| 10 |
+
<span class="vertical-text" style="background-color:lightgreen;border-radius: 3px;padding: 3px;"> </span>
|
| 11 |
+
<br>
|
| 12 |
+
<span class="vertical-text" style="background-color:orange;border-radius: 3px;padding: 3px;"> </span>
|
| 13 |
+
<br>
|
| 14 |
+
<span class="vertical-text" style="background-color:lightblue;border-radius: 3px;padding: 3px;"> Model: PRIMO ⭐</span>
|
| 15 |
+
<br>
|
| 16 |
+
<span class="vertical-text" style="background-color:tomato;border-radius: 3px;padding: 3px;"> Lang: IT</span>
|
| 17 |
+
<br>
|
| 18 |
+
<span class="vertical-text" style="background-color:lightgrey;border-radius: 3px;padding: 3px;"> </span>
|
| 19 |
+
<br>
|
| 20 |
+
<span class="vertical-text" style="background-color:#CF9FFF;border-radius: 3px;padding: 3px;"> </span>
|
| 21 |
+
</body>
|
| 22 |
+
|
| 23 |
+
--------------------------------------------------------------------------------------------------
|
| 24 |
+
|
| 25 |
+
<h3>Model description</h3>
|
| 26 |
+
|
| 27 |
+
This model is a <b>causal</b> language model for the <b>Italian</b> language, based on a GPT-like <b>[1]</b> architecture (more specifically, the model has been obtained by modifying Meta's XGLM architecture <b>[2]</b> and exploiting its 7.5B checkpoint).
|
| 28 |
+
|
| 29 |
+
The model has ~6.6B parameters and a vocabulary of 50.335 tokens. It is a foundation model, pre-trained for causal language modeling, so it is mainly suitable for basic natural language generation. It also has some zero-shot and few-shots inference capabilities, but you will have to fine-tune it in order to use it on more specific downstream tasks.
|
| 30 |
+
|
| 31 |
+
<h3>Quantization</h3>
|
| 32 |
+
|
| 33 |
+
The released checkpoint is quantized in 8-bit, so that it can easily be loaded and used for training and inference on ordinary hardware like consumer GPUs, and it requires the installation of the <b>transformers</b> library version >= 4.30.1 and the <b>bitsandbytes</b> library, version >= 0.37.2
|
| 34 |
+
|
| 35 |
+
On Windows operating systems, the <b>bitsandbytes-windows</b> module also needs to be installed on top. However, it appears that the module is not yet updated with some recent features, like the possibility to save the 8-bit quantized models.
|
| 36 |
+
In order to include this, you can install the fork in [this repo](https://github.com/francesco-russo-githubber/bitsandbytes-windows), using:
|
| 37 |
+
|
| 38 |
+
```bash
|
| 39 |
+
pip install git+https://github.com/francesco-russo-githubber/bitsandbytes-windows.git
|
| 40 |
+
```
|
| 41 |
+
|
| 42 |
+
<h3>Training</h3>
|
| 43 |
+
|
| 44 |
+
The model has been fine-tuned on a dataset of ~100K Italian prompt-response pairs, using low-rank adaptation, which took about 3 days on a NVIDIA GeForce RTX 3060 GPU. The training has been carried out with a batch size of 10 and a constant learning rate of 1e-5, exploiting gradient accumulation and gradient checkpointing in order to manage the considerable memory consumption.
|
| 45 |
+
|
| 46 |
+
<h3>Quick usage</h3>
|
| 47 |
+
|
| 48 |
+
In order to use the model for inference, it's strongly recommended to build a Gradio interface using the [code provided in this repo]()
|
| 49 |
+
|
| 50 |
+
<h3>Limitations</h3>
|
| 51 |
+
|
| 52 |
+
The model might behave erratically when presented with prompts which are too far away from its pre-training or fine-tuning and, because of the probabilistic nature of its generation, it might occasionally produce biased or offensive content with respect to gender, race, ideologies, and political or religious beliefs.
|
| 53 |
+
These limitations imply that the model and its outputs should be used with caution, and should not be involved in situations that require the generated text to be fair or true.
|
| 54 |
+
|
| 55 |
+
<h3>References</h3>
|
| 56 |
+
|
| 57 |
+
[1] https://arxiv.org/abs/2005.14165
|
| 58 |
+
|
| 59 |
+
[2] https://arxiv.org/abs/2112.10668
|
| 60 |
+
|
| 61 |
+
<h3>License</h3>
|
| 62 |
+
|
| 63 |
+
The model is released under <b>CC-BY-NC-SA-3.0</b> license, which means it is NOT available for commercial use, but only for research purposes. This is due to the experimental nature of the model and the license of the training data.
|