Update README.md
Browse files
README.md
CHANGED
@@ -34,11 +34,11 @@ inference: false
|
|
34 |
|
35 |
This model is a fine-tuned version of [BramVanroy/GEITje-7B-ultra](https://huggingface.co/BramVanroy/GEITje-7B-ultra) on the [snoels/FinGEITje-sft](https://huggingface.co/datasets/snoels/FinGEITje-sft) dataset.
|
36 |
|
37 |
-
## Model Description
|
38 |
|
39 |
FinGEITje 7B is a large open Dutch financial language model with 7 billion parameters, based on Mistral 7B. It has been further trained on Dutch financial texts, enhancing its proficiency in the Dutch language and its knowledge of financial topics. As a result, FinGEITje provides more accurate and relevant responses in the domain of finance.
|
40 |
|
41 |
-
## Training and Evaluation Data
|
42 |
|
43 |
### Training Data
|
44 |
|
@@ -57,7 +57,7 @@ The model was evaluated using:
|
|
57 |
|
58 |
- **[snoels/FinDutchBench](https://huggingface.co/datasets/snoels/FinDutchBench)**: A Dutch financial benchmark dataset designed to assess the model's performance on various financial tasks.
|
59 |
|
60 |
-
## Training Procedure
|
61 |
|
62 |
FinGEITje was trained following the methodology described in the [Alignment Handbook](https://github.com/huggingface/alignment-handbook).
|
63 |
|
@@ -103,7 +103,7 @@ The evaluation package includes a set of metrics defined per task, grouped per d
|
|
103 |
- **Datasets**: 2.14.6
|
104 |
- **Tokenizers**: 0.15.2
|
105 |
|
106 |
-
## How to Use
|
107 |
|
108 |
FinGEITje 7B can be utilized using the Hugging Face Transformers library along with PEFT to load the LoRA adapters efficiently.
|
109 |
|
@@ -145,7 +145,7 @@ response = tokenizer.decode(outputs[0], skip_special_tokens=True)
|
|
145 |
print(response)
|
146 |
```
|
147 |
|
148 |
-
## Limitations and Future Work
|
149 |
|
150 |
While FinGEITje 7B demonstrates significant improvements in understanding and generating Dutch financial content, certain limitations exist:
|
151 |
|
@@ -155,7 +155,6 @@ While FinGEITje 7B demonstrates significant improvements in understanding and ge
|
|
155 |
- **Language Scope**: Primarily designed for Dutch; performance in other languages is not optimized.
|
156 |
- **Ethical Use**: Users should ensure that the model's outputs comply with ethical standards and do not promote misinformation or harmful content.
|
157 |
|
158 |
-
|
159 |
### Future Work
|
160 |
|
161 |
- **Data Updates**: Incorporate more recent and diverse financial datasets to keep the model up-to-date.
|
@@ -163,7 +162,7 @@ While FinGEITje 7B demonstrates significant improvements in understanding and ge
|
|
163 |
- **Performance Enhancement**: Fine-tune on more specialized financial topics and complex financial tasks.
|
164 |
- **Multilingual Expansion**: Extend support to other languages relevant to the financial sector in the Netherlands and Europe.
|
165 |
|
166 |
-
## Acknowledgements
|
167 |
|
168 |
We would like to thank:
|
169 |
|
@@ -171,7 +170,7 @@ We would like to thank:
|
|
171 |
- **Bram Vanroy** ([GitHub](https://github.com/BramVanroy)) for creating [GEITje-7B-ultra](https://huggingface.co/BramVanroy/GEITje-7B-ultra), an open-source Dutch chat model, and for sharing training, translation, and evaluation resources.
|
172 |
- **Contributors of the [Alignment Handbook](https://github.com/huggingface/alignment-handbook)** for providing valuable resources that guided the development and training process of FinGEITje.
|
173 |
|
174 |
-
## Citation
|
175 |
|
176 |
If you use FinGEITje in your work, please cite:
|
177 |
|
@@ -185,10 +184,10 @@ If you use FinGEITje in your work, please cite:
|
|
185 |
}
|
186 |
```
|
187 |
|
188 |
-
## License
|
189 |
|
190 |
This model is licensed under the [Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)](https://creativecommons.org/licenses/by-nc/4.0/) license.
|
191 |
|
192 |
-
## Contact
|
193 |
|
194 |
For any inquiries or questions, please contact [Sander Noels](mailto:sander.noels@ugent.be).
|
|
|
34 |
|
35 |
This model is a fine-tuned version of [BramVanroy/GEITje-7B-ultra](https://huggingface.co/BramVanroy/GEITje-7B-ultra) on the [snoels/FinGEITje-sft](https://huggingface.co/datasets/snoels/FinGEITje-sft) dataset.
|
36 |
|
37 |
+
## π Model Description
|
38 |
|
39 |
FinGEITje 7B is a large open Dutch financial language model with 7 billion parameters, based on Mistral 7B. It has been further trained on Dutch financial texts, enhancing its proficiency in the Dutch language and its knowledge of financial topics. As a result, FinGEITje provides more accurate and relevant responses in the domain of finance.
|
40 |
|
41 |
+
## π Training and Evaluation Data
|
42 |
|
43 |
### Training Data
|
44 |
|
|
|
57 |
|
58 |
- **[snoels/FinDutchBench](https://huggingface.co/datasets/snoels/FinDutchBench)**: A Dutch financial benchmark dataset designed to assess the model's performance on various financial tasks.
|
59 |
|
60 |
+
## βοΈ Training Procedure
|
61 |
|
62 |
FinGEITje was trained following the methodology described in the [Alignment Handbook](https://github.com/huggingface/alignment-handbook).
|
63 |
|
|
|
103 |
- **Datasets**: 2.14.6
|
104 |
- **Tokenizers**: 0.15.2
|
105 |
|
106 |
+
## π οΈ How to Use
|
107 |
|
108 |
FinGEITje 7B can be utilized using the Hugging Face Transformers library along with PEFT to load the LoRA adapters efficiently.
|
109 |
|
|
|
145 |
print(response)
|
146 |
```
|
147 |
|
148 |
+
## π§ Limitations and Future Work
|
149 |
|
150 |
While FinGEITje 7B demonstrates significant improvements in understanding and generating Dutch financial content, certain limitations exist:
|
151 |
|
|
|
155 |
- **Language Scope**: Primarily designed for Dutch; performance in other languages is not optimized.
|
156 |
- **Ethical Use**: Users should ensure that the model's outputs comply with ethical standards and do not promote misinformation or harmful content.
|
157 |
|
|
|
158 |
### Future Work
|
159 |
|
160 |
- **Data Updates**: Incorporate more recent and diverse financial datasets to keep the model up-to-date.
|
|
|
162 |
- **Performance Enhancement**: Fine-tune on more specialized financial topics and complex financial tasks.
|
163 |
- **Multilingual Expansion**: Extend support to other languages relevant to the financial sector in the Netherlands and Europe.
|
164 |
|
165 |
+
## π Acknowledgements
|
166 |
|
167 |
We would like to thank:
|
168 |
|
|
|
170 |
- **Bram Vanroy** ([GitHub](https://github.com/BramVanroy)) for creating [GEITje-7B-ultra](https://huggingface.co/BramVanroy/GEITje-7B-ultra), an open-source Dutch chat model, and for sharing training, translation, and evaluation resources.
|
171 |
- **Contributors of the [Alignment Handbook](https://github.com/huggingface/alignment-handbook)** for providing valuable resources that guided the development and training process of FinGEITje.
|
172 |
|
173 |
+
## π Citation
|
174 |
|
175 |
If you use FinGEITje in your work, please cite:
|
176 |
|
|
|
184 |
}
|
185 |
```
|
186 |
|
187 |
+
## π License
|
188 |
|
189 |
This model is licensed under the [Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)](https://creativecommons.org/licenses/by-nc/4.0/) license.
|
190 |
|
191 |
+
## π§ Contact
|
192 |
|
193 |
For any inquiries or questions, please contact [Sander Noels](mailto:sander.noels@ugent.be).
|