Update README.md
Browse files
README.md
CHANGED
@@ -9,197 +9,34 @@ base_model:
|
|
9 |
- meta-llama/Llama-3.2-3B
|
10 |
---
|
11 |
|
12 |
-
#
|
13 |
|
14 |
-
|
15 |
|
|
|
16 |
|
|
|
17 |
|
18 |
-
|
19 |
|
20 |
-
|
|
|
|
|
|
|
21 |
|
22 |
-
|
23 |
|
24 |
-
|
|
|
|
|
|
|
25 |
|
26 |
-
|
27 |
-
- **Funded by [optional]:** [More Information Needed]
|
28 |
-
- **Shared by [optional]:** [More Information Needed]
|
29 |
-
- **Model type:** [More Information Needed]
|
30 |
-
- **Language(s) (NLP):** [More Information Needed]
|
31 |
-
- **License:** [More Information Needed]
|
32 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
33 |
|
34 |
-
|
35 |
|
36 |
-
|
|
|
|
|
37 |
|
38 |
-
|
39 |
-
- **Paper [optional]:** [More Information Needed]
|
40 |
-
- **Demo [optional]:** [More Information Needed]
|
41 |
-
|
42 |
-
## Uses
|
43 |
-
|
44 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
45 |
-
|
46 |
-
### Direct Use
|
47 |
-
|
48 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
49 |
-
|
50 |
-
[More Information Needed]
|
51 |
-
|
52 |
-
### Downstream Use [optional]
|
53 |
-
|
54 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
55 |
-
|
56 |
-
[More Information Needed]
|
57 |
-
|
58 |
-
### Out-of-Scope Use
|
59 |
-
|
60 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
61 |
-
|
62 |
-
[More Information Needed]
|
63 |
-
|
64 |
-
## Bias, Risks, and Limitations
|
65 |
-
|
66 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
67 |
-
|
68 |
-
[More Information Needed]
|
69 |
-
|
70 |
-
### Recommendations
|
71 |
-
|
72 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
73 |
-
|
74 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
75 |
-
|
76 |
-
## How to Get Started with the Model
|
77 |
-
|
78 |
-
Use the code below to get started with the model.
|
79 |
-
|
80 |
-
[More Information Needed]
|
81 |
-
|
82 |
-
## Training Details
|
83 |
-
|
84 |
-
### Training Data
|
85 |
-
|
86 |
-
<!-- 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. -->
|
87 |
-
|
88 |
-
[More Information Needed]
|
89 |
-
|
90 |
-
### Training Procedure
|
91 |
-
|
92 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
93 |
-
|
94 |
-
#### Preprocessing [optional]
|
95 |
-
|
96 |
-
[More Information Needed]
|
97 |
-
|
98 |
-
|
99 |
-
#### Training Hyperparameters
|
100 |
-
|
101 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
102 |
-
|
103 |
-
#### Speeds, Sizes, Times [optional]
|
104 |
-
|
105 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
106 |
-
|
107 |
-
[More Information Needed]
|
108 |
-
|
109 |
-
## Evaluation
|
110 |
-
|
111 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
112 |
-
|
113 |
-
### Testing Data, Factors & Metrics
|
114 |
-
|
115 |
-
#### Testing Data
|
116 |
-
|
117 |
-
<!-- This should link to a Dataset Card if possible. -->
|
118 |
-
|
119 |
-
[More Information Needed]
|
120 |
-
|
121 |
-
#### Factors
|
122 |
-
|
123 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
124 |
-
|
125 |
-
[More Information Needed]
|
126 |
-
|
127 |
-
#### Metrics
|
128 |
-
|
129 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
130 |
-
|
131 |
-
[More Information Needed]
|
132 |
-
|
133 |
-
### Results
|
134 |
-
|
135 |
-
[More Information Needed]
|
136 |
-
|
137 |
-
#### Summary
|
138 |
-
|
139 |
-
|
140 |
-
|
141 |
-
## Model Examination [optional]
|
142 |
-
|
143 |
-
<!-- Relevant interpretability work for the model goes here -->
|
144 |
-
|
145 |
-
[More Information Needed]
|
146 |
-
|
147 |
-
## Environmental Impact
|
148 |
-
|
149 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
150 |
-
|
151 |
-
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).
|
152 |
-
|
153 |
-
- **Hardware Type:** [More Information Needed]
|
154 |
-
- **Hours used:** [More Information Needed]
|
155 |
-
- **Cloud Provider:** [More Information Needed]
|
156 |
-
- **Compute Region:** [More Information Needed]
|
157 |
-
- **Carbon Emitted:** [More Information Needed]
|
158 |
-
|
159 |
-
## Technical Specifications [optional]
|
160 |
-
|
161 |
-
### Model Architecture and Objective
|
162 |
-
|
163 |
-
[More Information Needed]
|
164 |
-
|
165 |
-
### Compute Infrastructure
|
166 |
-
|
167 |
-
[More Information Needed]
|
168 |
-
|
169 |
-
#### Hardware
|
170 |
-
|
171 |
-
[More Information Needed]
|
172 |
-
|
173 |
-
#### Software
|
174 |
-
|
175 |
-
[More Information Needed]
|
176 |
-
|
177 |
-
## Citation [optional]
|
178 |
-
|
179 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
180 |
-
|
181 |
-
**BibTeX:**
|
182 |
-
|
183 |
-
[More Information Needed]
|
184 |
-
|
185 |
-
**APA:**
|
186 |
-
|
187 |
-
[More Information Needed]
|
188 |
-
|
189 |
-
## Glossary [optional]
|
190 |
-
|
191 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
192 |
-
|
193 |
-
[More Information Needed]
|
194 |
-
|
195 |
-
## More Information [optional]
|
196 |
-
|
197 |
-
[More Information Needed]
|
198 |
-
|
199 |
-
## Model Card Authors [optional]
|
200 |
-
|
201 |
-
[More Information Needed]
|
202 |
-
|
203 |
-
## Model Card Contact
|
204 |
-
|
205 |
-
[More Information Needed]
|
|
|
9 |
- meta-llama/Llama-3.2-3B
|
10 |
---
|
11 |
|
12 |
+
# Everyday-Language-3B
|
13 |
|
14 |
+
Everyday-Language-3B is a language model fine-tuned for generating natural, everyday English text. It builds upon a pre-trained 3 billion parameter base model (Llama-3.2-3B) and has been further trained on the **Everyday-Language-Corpus** dataset, a collection of over 8,700 examples of common phrases, questions, and statements encountered in daily interactions.
|
15 |
|
16 |
+
This fine-tuning process significantly improves the model's ability to produce coherent, contextually appropriate, and less repetitive text compared to its base version. It aims to better capture the nuances and patterns of typical conversational language.
|
17 |
|
18 |
+
## Intended Uses & Limitations
|
19 |
|
20 |
+
**Intended Uses:**
|
21 |
|
22 |
+
* **Generating natural language responses in conversational AI applications.**
|
23 |
+
* **Creating more human-like text for creative writing or content generation.**
|
24 |
+
* **Exploring the capabilities of language models in understanding and producing everyday language.**
|
25 |
+
* **Serving as a foundation for further fine-tuning on specific downstream tasks.**
|
26 |
|
27 |
+
**Limitations:**
|
28 |
|
29 |
+
* **Contextual Understanding:** While improved, the model's contextual understanding is still limited by the size of its context window and the inherent complexities of language.
|
30 |
+
* **Potential Biases:** Like all language models, Everyday-Language-3B may inherit biases from its pre-training data and the fine-tuning dataset. These biases can manifest in the generated text, potentially leading to outputs that reflect societal stereotypes or unfair assumptions.
|
31 |
+
* **Factuality:** The model may generate text that is not factually accurate, especially when dealing with complex or nuanced topics. It's crucial to verify information generated by the model before relying on it.
|
32 |
+
* **Repetition:** Although significantly reduced due to fine-tuning, the model may still exhibit some repetition in longer generated text.
|
33 |
|
34 |
+
## Training Data
|
|
|
|
|
|
|
|
|
|
|
|
|
35 |
|
36 |
+
Everyday-Language-3B was fine-tuned on the **Everyday-Language-Corpus** dataset, which is publicly available on Hugging Face:
|
37 |
|
38 |
+
* **Dataset:** [MultivexAI/Everyday-Language-Corpus](https://huggingface.co/datasets/MultivexAI/Everyday-Language-Corpus)
|
39 |
+
* **Dataset Description:** A collection of 8,787 synthetically generated examples of everyday English, structured as \[S] {Sentence or Sentences} \[E].
|
40 |
+
* **Dataset Focus:** Common phrases, questions, and statements used in typical daily interactions.
|
41 |
|
42 |
+
**Final loss: 1.143400**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|