rovi27 andreamorgar commited on
Commit
b60c92c
1 Parent(s): cf9df2e

update readme (#1)

Browse files

- update readme (83fc50212b4fbb68cd1253e159d8f3b3152de66d)


Co-authored-by: Andrea Morales Garzón <[email protected]>

Files changed (1) hide show
  1. README.md +47 -3
README.md CHANGED
@@ -13,12 +13,56 @@ base_model: unsloth/gemma-2b-it-bnb-4bit
13
 
14
  # Uploaded model
15
 
16
- - **Developed by:** somosnlp
17
- - **License:** apache-2.0
18
- - **Finetuned from model :** unsloth/gemma-2b-it-bnb-4bit
 
 
 
 
 
 
 
 
 
 
 
 
 
19
 
20
  This gemma model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
21
 
22
  More info in https://huggingface.co/datasets/somosnlp/RecetasDeLaAbuela
23
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
24
  [<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
 
13
 
14
  # Uploaded model
15
 
16
+ <!-- Resumen del modelo. -->
17
+
18
+ - **Developed by:** rovi27, sbenel, GaboTuco, iXrst, andreamorgar
19
+ - **Funded by:** SomosNLP, HuggingFace
20
+ - **Model type:** Language model, instruction tuned
21
+ - **Language(s):** `es-CL`, `es-ES`, `es-MX`, `es-PE`
22
+ - **License:** apache-2.0
23
+ - **Fine-tuned from model:** https://huggingface.co/unsloth/gemma-2b-bnb-4bit
24
+ - **Dataset used:** [More Information Needed] <!-- Enlace al dataset utilizado para el ajuste -->
25
+
26
+ ### Model Sources
27
+
28
+ - **Repository:** https://github.com/recetasdelaabuela/somosnlp
29
+ - **Paper:** Comming soon!
30
+ - **Demo:** https://huggingface.co/spaces/somosnlp/ComeBien_Demo
31
+ - **Video presentation:** https://www.youtube.com/watch?v=WK-1F1TX5d4&list=PLTA-KAy8nxaASMwEUWkkTfMaDxWBxn-8J&index=19
32
 
33
  This gemma model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
34
 
35
  More info in https://huggingface.co/datasets/somosnlp/RecetasDeLaAbuela
36
 
37
+
38
+ ## Uses
39
+
40
+ This models aims to provide a tool to improve healthy cooking habits.
41
+
42
+ ### Direct Use
43
+
44
+ Enhance recipes from Spanish-speaking countries with their nutritional values to help improve our relationship with food.
45
+ The ultimate goal is to construct a Spanish-language specific intelligent nutrition assistant."
46
+
47
+
48
+ ### Out-of-Scope Use
49
+
50
+ This model will not work well for nutrititional needs from under-represented areas, as well as recipes in other languages rather than Spanish.
51
+
52
+ [More Information Needed]
53
+
54
+ ## Bias, Risks, and Limitations
55
+
56
+ This model has been trained using the data provided in the training dataset without the supervision of nutrition experts.
57
+ Please use it wisely and always consider the recommendations and guidelines from international health foundations.
58
+
59
+ The model has been trained with recipes in Spanish from different areas of the world.
60
+ Therefore, there can be biases regarding overrepresented areas, and some geographical areas may not be under-representation.
61
+ We encourage the open-source community to collaborate in improving the dataset to cover as many geographic areas as possible!
62
+
63
+ ### Recommendations
64
+
65
+ Users should be made aware of the risks, biases and limitations of the model.
66
+
67
+
68
  [<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)