Kimargin commited on
Commit
9215450
·
verified ·
1 Parent(s): b068411

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +94 -194
README.md CHANGED
@@ -8,200 +8,100 @@ license: apache-2.0
8
  datasets:
9
  - legacy-datasets/wikipedia
10
  metrics:
 
11
  - accuracy
12
  ---
13
 
14
- # Model Card for Model ID
15
-
16
- <!-- Provide a quick summary of what the model is/does. -->
17
-
18
-
19
-
20
- ## Model Details
21
-
22
- ### Model Description
23
-
24
- <!-- Provide a longer summary of what this model is. -->
25
-
26
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
27
-
28
- - **Developed by:** [More Information Needed]
29
- - **Funded by [optional]:** [More Information Needed]
30
- - **Shared by [optional]:** [More Information Needed]
31
- - **Model type:** [More Information Needed]
32
- - **Language(s) (NLP):** [More Information Needed]
33
- - **License:** [More Information Needed]
34
- - **Finetuned from model [optional]:** [More Information Needed]
35
-
36
- ### Model Sources [optional]
37
-
38
- <!-- Provide the basic links for the model. -->
39
-
40
- - **Repository:** [More Information Needed]
41
- - **Paper [optional]:** [More Information Needed]
42
- - **Demo [optional]:** [More Information Needed]
43
-
44
- ## Uses
45
-
46
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
47
-
48
- ### Direct Use
49
-
50
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
51
-
52
- [More Information Needed]
53
-
54
- ### Downstream Use [optional]
55
-
56
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
57
-
58
- [More Information Needed]
59
-
60
- ### Out-of-Scope Use
61
-
62
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
63
-
64
- [More Information Needed]
65
-
66
- ## Bias, Risks, and Limitations
67
-
68
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
69
-
70
- [More Information Needed]
71
-
72
- ### Recommendations
73
-
74
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
75
-
76
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
77
-
78
- ## How to Get Started with the Model
79
-
80
- Use the code below to get started with the model.
81
-
82
- [More Information Needed]
83
-
84
- ## Training Details
85
-
86
- ### Training Data
87
-
88
- <!-- 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. -->
89
-
90
- [More Information Needed]
91
-
92
- ### Training Procedure
93
-
94
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
95
-
96
- #### Preprocessing [optional]
97
-
98
- [More Information Needed]
99
-
100
-
101
- #### Training Hyperparameters
102
-
103
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
104
-
105
- #### Speeds, Sizes, Times [optional]
106
-
107
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
108
-
109
- [More Information Needed]
110
-
111
- ## Evaluation
112
-
113
- <!-- This section describes the evaluation protocols and provides the results. -->
114
-
115
- ### Testing Data, Factors & Metrics
116
-
117
- #### Testing Data
118
-
119
- <!-- This should link to a Dataset Card if possible. -->
120
-
121
- [More Information Needed]
122
-
123
- #### Factors
124
-
125
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
126
-
127
- [More Information Needed]
128
-
129
- #### Metrics
130
-
131
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
132
-
133
- [More Information Needed]
134
-
135
- ### Results
136
-
137
- [More Information Needed]
138
-
139
- #### Summary
140
-
141
-
142
-
143
- ## Model Examination [optional]
144
-
145
- <!-- Relevant interpretability work for the model goes here -->
146
-
147
- [More Information Needed]
148
-
149
- ## Environmental Impact
150
-
151
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
152
-
153
- 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).
154
-
155
- - **Hardware Type:** [More Information Needed]
156
- - **Hours used:** [More Information Needed]
157
- - **Cloud Provider:** [More Information Needed]
158
- - **Compute Region:** [More Information Needed]
159
- - **Carbon Emitted:** [More Information Needed]
160
-
161
- ## Technical Specifications [optional]
162
-
163
- ### Model Architecture and Objective
164
-
165
- [More Information Needed]
166
-
167
- ### Compute Infrastructure
168
-
169
- [More Information Needed]
170
-
171
- #### Hardware
172
-
173
- [More Information Needed]
174
-
175
- #### Software
176
-
177
- [More Information Needed]
178
-
179
- ## Citation [optional]
180
-
181
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
182
-
183
- **BibTeX:**
184
-
185
- [More Information Needed]
186
-
187
- **APA:**
188
-
189
- [More Information Needed]
190
-
191
- ## Glossary [optional]
192
-
193
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
194
-
195
- [More Information Needed]
196
-
197
- ## More Information [optional]
198
-
199
- [More Information Needed]
200
-
201
- ## Model Card Authors [optional]
202
-
203
- [More Information Needed]
204
-
205
- ## Model Card Contact
206
-
207
- [More Information Needed]
 
8
  datasets:
9
  - legacy-datasets/wikipedia
10
  metrics:
11
+ - perplexity
12
  - accuracy
13
  ---
14
 
15
+ Model Card for GPT-NEO-1.3B-wiki
16
+ Model Details
17
+ Model Description
18
+ This model is a fine-tuned version of EleutherAI/gpt-neo-1.3B. It has been fine-tuned on the Wikipedia dataset for tasks such as text generation, summarization, and question-answering in the English language. The model uses a causal language modeling objective and is capable of generating contextually coherent text.
19
+
20
+ Developed by: Kimargin
21
+ Model type: Fine-tuned model
22
+ Language(s): English
23
+ License: Apache 2.0
24
+ Finetuned from model: EleutherAI/gpt-neo-1.3B
25
+ Model Sources
26
+ Repository: Kimargin/GPT-NEO-1.3B-wiki
27
+ Uses
28
+ Direct Use
29
+ This model can be used directly for generating text, summarizing documents, and answering factual questions based on context. It is suitable for general-purpose NLP tasks where coherent and fluent text generation is needed.
30
+
31
+ Downstream Use
32
+ Users can fine-tune this model further for specialized tasks such as summarization of domain-specific texts (e.g., legal or medical texts), generating code, or answering specific types of questions.
33
+
34
+ Out-of-Scope Use
35
+ The model is not suitable for real-time decision-making in critical applications, such as medical or legal advice. It may produce biased or inaccurate text if given ambiguous or politically sensitive input.
36
+
37
+ Bias, Risks, and Limitations
38
+ This model was trained on Wikipedia data, which could contain biases inherent in the dataset. The model may reflect those biases in its output. Additionally, the model may not handle very specialized knowledge domains accurately.
39
+
40
+ Recommendations
41
+ Users should carefully review and verify the text generated by the model before using it in any critical applications. The model should be used in scenarios where generated outputs can be reviewed by a human to mitigate any potential biases or inaccuracies.
42
+
43
+ How to Get Started with the Model
44
+ To use this model, you can load it with the following code:
45
+
46
+ python
47
+ Copy code
48
+ from transformers import AutoModelForCausalLM, AutoTokenizer
49
+
50
+ tokenizer = AutoTokenizer.from_pretrained("Kimargin/GPT-NEO-1.3B-wiki")
51
+ model = AutoModelForCausalLM.from_pretrained("Kimargin/GPT-NEO-1.3B-wiki")
52
+
53
+ input_text = "Explain the history of the internet."
54
+ inputs = tokenizer(input_text, return_tensors="pt")
55
+ outputs = model.generate(inputs["input_ids"], max_length=100)
56
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
57
+ Training Details
58
+ Training Data
59
+ The model was fine-tuned on a subset of the English Wikipedia dataset, which includes a broad range of topics and domains. The dataset is generally factual but may still contain biases.
60
+
61
+ Training Procedure
62
+ The model was trained using mixed precision (float16) on GPU hardware.
63
+
64
+ Training Hyperparameters
65
+ Learning rate: 5e-5
66
+ Batch size: 16
67
+ Epochs: 3
68
+ Precision: float16 (mixed precision)
69
+ Evaluation
70
+ Testing Data
71
+ The model was evaluated on a held-out validation subset of the Wikipedia dataset.
72
+
73
+ Factors
74
+ General domain knowledge: The model performs well on generating factual and coherent text on common knowledge topics covered in Wikipedia.
75
+ Contextual understanding: The model can maintain coherence over relatively long text sequences but may struggle with very specialized or niche topics.
76
+ Metrics
77
+ Perplexity: The model achieved a perplexity of 25.3 on the validation set.
78
+ Accuracy: Measured by manual evaluation of text generation for accuracy in answering factual questions.
79
+ Results
80
+ The model demonstrates strong capabilities in general-purpose text generation and answering factual questions. However, it can generate irrelevant or biased responses in edge cases, especially with ambiguous input.
81
+
82
+ Environmental Impact
83
+ Carbon emissions can be estimated using the Machine Learning Impact calculator presented in Lacoste et al. (2019).
84
+
85
+ Hardware Type: NVIDIA A100 GPUs
86
+ Hours used: 20 hours
87
+ Cloud Provider: Google Cloud
88
+ Compute Region: US-Central
89
+ Carbon Emitted: ~50 kg CO2
90
+ Technical Specifications
91
+ Model Architecture and Objective
92
+ The model is a causal language model with 1.3 billion parameters based on the GPT-Neo architecture.
93
+
94
+ Compute Infrastructure
95
+ The model was trained on NVIDIA A100 GPUs using Google Cloud infrastructure.
96
+
97
+ Citation
98
+ If you use this model, please cite it as follows:
99
+
100
+ bibtex
101
+ Copy code
102
+ @article{gpt-neo,
103
+ author = {EleutherAI},
104
+ title = {GPT-Neo: Large Scale Autoregressive Language Model},
105
+ year = {2021},
106
+ url = {https://github.com/EleutherAI/gpt-neo}
107
+ }