nakato-nk commited on
Commit
6b06a4f
·
1 Parent(s): 5804888

readme update

Browse files
Files changed (1) hide show
  1. README.md +41 -159
README.md CHANGED
@@ -1,202 +1,84 @@
1
  ---
2
  base_model: unsloth/llama-3.2-1b-instruct-bnb-4bit
3
  library_name: peft
 
 
 
 
 
 
 
 
 
 
 
 
4
  ---
5
 
6
  # Model Card for Model ID
7
-
8
- <!-- Provide a quick summary of what the model is/does. -->
9
-
10
-
11
 
12
  ## Model Details
13
 
14
  ### Model Description
 
15
 
16
- <!-- Provide a longer summary of what this model is. -->
17
 
18
 
19
-
20
- - **Developed by:** [More Information Needed]
21
  - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
 
 
30
  <!-- Provide the basic links for the model. -->
31
 
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
 
58
  ## Bias, Risks, and Limitations
59
 
60
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
 
64
  ### Recommendations
65
 
66
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
 
70
  ## How to Get Started with the Model
71
 
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
  ## Training Details
77
 
78
  ### Training Data
79
 
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
 
84
  ### Training Procedure
85
 
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
 
93
  #### Training Hyperparameters
94
 
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
 
195
- [More Information Needed]
196
 
197
- ## Model Card Contact
198
 
199
- [More Information Needed]
200
  ### Framework versions
201
 
202
- - PEFT 0.14.0
 
 
1
  ---
2
  base_model: unsloth/llama-3.2-1b-instruct-bnb-4bit
3
  library_name: peft
4
+ language:
5
+ - es
6
+ - en
7
+ tags:
8
+ - llama-3
9
+ - llama
10
+ - meta
11
+ - facebook
12
+ - unsloth
13
+ - deepsphere
14
+ - deepsphereAI
15
+ - transformers
16
  ---
17
 
18
  # Model Card for Model ID
19
+ El Modelo RaMem (Rag as Memory) implementa el enfoque de usar RAG para potenciar modelos pequeños y hacerlos muy competentes para el hardware limitado para el que son diseñados.
 
 
 
20
 
21
  ## Model Details
22
 
23
  ### Model Description
24
+ RaMen es un Modelo de Lenguaje Pequeño, con la particularidad de que es muy poderoso, ya que integra Rag como Memoria (RaMen). Este enfoque proviene de la limitación de la ventana de contexto de los modelos de lenguaje, usando un sistema RAG para recuperar información relevante y añadirla como contexto esto se soluciona en parte.
25
 
26
+ El modelo fue fine-tuneado con una combinación de datasets, por una parte está el OASST_2 dataset y por otra parte un dataset generado sinteticamente con ayuda de modelos como DeepSeek y ChatGPT logrando así crear un gran dataset, la finalidad de este dataset no es que el modelo aprenda a generar buenas respuestas, ya que para eso está el enfoque RAG, sino que el modelo pueda afinar su conocimiento sobre la lengua española para evitar lo más posible incoherencias en la respuesta.
27
 
28
 
29
+ - **Developed by:** [Nakato](https://huggingface.co/nakato-nk)
 
30
  - **Funded by [optional]:** [More Information Needed]
31
+ - **Model type:** chat
32
+ - **Language(s) (NLP):** Español, Ingles
33
+ - **License:** [cc-by-nc-sa-4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en)
34
+ - **Finetuned from model:** [unsloth/Llama-3.2-1B-Instruct](https://huggingface.co/unsloth/Llama-3.2-1B-Instruct)
35
+ - **Model Release Date**: Marzo 22, 2025
 
 
36
 
37
+ ### Model Sources
38
  <!-- Provide the basic links for the model. -->
39
 
40
+ - **Repository:** [RaMem Github](https://github.com/Deep-Sphere-AI/RaMem)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
41
 
42
  ## Bias, Risks, and Limitations
43
 
44
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
45
+ Al ser un Modelo pequeño, tiene algunas limitaciones, ya sea en la coherencia de las respuestas, alucinaciones, ventana de contexto pequeña, etc. Las capacidades de este modelo vienen potenciadas por el RAG, sin ellas es solo un modelo de 1B de parametros finetuneado para español.
 
46
 
47
  ### Recommendations
48
 
49
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
50
+ Es un modelo pequeño, es óptimo para correr en hardware limitado, lo que hace que la mayoría de personas pueden usarlo. Se recomiendo usar la plantilla de chat predefinida y no pasar de la ventana de contexto de 2048 tokens. Tampoco usarlo de forma profesional como ChatGPT.
 
51
 
52
  ## How to Get Started with the Model
53
 
 
 
 
 
54
  ## Training Details
55
 
56
  ### Training Data
57
 
58
+ El dataset usado es una mezcla entre el ya conocido OASST2 y un datset sintétic elaborado con la ayuda de modelos como DeepSeek y ChatGPT, todos los ejemplos tienen un system prompt. Y se aplicó el chat template de LLama 3.1
 
 
59
 
60
  ### Training Procedure
61
 
62
+ #### Preprocessing
63
+ Se ha usado el chat template proporcionado por Meta, para LLama 3.1, el dataset ya se encuentra en un formato que permite aplicar el chat tempalte.
64
+ Antes de tokenizar los datos se hagrega un sistem prompt en caso las conversaciones no lo tengan. Además se ha cambiado en todo el dataset las referencias sobre el nombre del modelo por RaMem.
 
 
 
65
 
66
  #### Training Hyperparameters
67
 
68
+ - **max_seq_length**: 4096 (RoPE scaling)
69
+ - **lora_alpha**: 16
70
+ - **lora_dropout**: 0
71
+ - **epochs**: 1
72
+ - **learning_rate**: 2e-4
73
+ - **per_device_train_batch_size**: 2
74
+ - **gradient_accumulation_steps**: 4
75
+ -
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
76
 
77
+ ## Model Card Authors
78
 
79
+ - Nakato
80
 
 
81
  ### Framework versions
82
 
83
+ - PEFT 0.14.0
84
+ - unsloth 2025.3.17