ColleenMacklin commited on
Commit
8d2a72b
1 Parent(s): aba229a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +195 -1
README.md CHANGED
@@ -1,4 +1,198 @@
1
-
2
  ---
3
  license: cc-by-nc-sa-4.0
 
 
4
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: cc-by-nc-sa-4.0
3
+ language:
4
+ - en
5
  ---
6
+ # Model Card for Model ID
7
+
8
+ <!-- Provide a quick summary of what the model is/does. -->
9
+
10
+ This is a gpt_neo (125M) text generation model fine-tuned on a single book: Bertant Russell's The Problems of Philosophy, from 1912.
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
+ - **Shared by [optional]:** [More Information Needed]
22
+ - **Model type:** [More Information Needed]
23
+ - **Language(s) (NLP):** [More Information Needed]
24
+ - **License:** [More Information Needed]
25
+ - **Finetuned from model [optional]:** [More Information Needed]
26
+
27
+ ## Model Sources [optional]
28
+
29
+ <!-- Provide the basic links for the model. -->
30
+
31
+ - **Repository:** [More Information Needed]
32
+ - **Paper [optional]:** [More Information Needed]
33
+ - **Demo [optional]:** [More Information Needed]
34
+
35
+ # Uses
36
+
37
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
38
+
39
+ ## Direct Use
40
+
41
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
42
+
43
+ [More Information Needed]
44
+
45
+ ## Downstream Use [optional]
46
+
47
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
48
+
49
+ [More Information Needed]
50
+
51
+ ## Out-of-Scope Use
52
+
53
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
54
+
55
+ [More Information Needed]
56
+
57
+ # Bias, Risks, and Limitations
58
+
59
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
60
+
61
+ [More Information Needed]
62
+
63
+ ## Recommendations
64
+
65
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
66
+
67
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
68
+
69
+ # Training Details
70
+
71
+ ## Training Data
72
+
73
+ <!-- This should link to a Data 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. -->
74
+
75
+ [More Information Needed]
76
+
77
+ ## Training Procedure [optional]
78
+
79
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
80
+
81
+ ### Preprocessing
82
+
83
+ [More Information Needed]
84
+
85
+ ### Speeds, Sizes, Times
86
+
87
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
88
+
89
+ [More Information Needed]
90
+
91
+ # Evaluation
92
+
93
+ <!-- This section describes the evaluation protocols and provides the results. -->
94
+
95
+ ## Testing Data, Factors & Metrics
96
+
97
+ ### Testing Data
98
+
99
+ <!-- This should link to a Data Card if possible. -->
100
+
101
+ [More Information Needed]
102
+
103
+ ### Factors
104
+
105
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
106
+
107
+ [More Information Needed]
108
+
109
+ ### Metrics
110
+
111
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
112
+
113
+ [More Information Needed]
114
+
115
+ ## Results
116
+
117
+ [More Information Needed]
118
+
119
+ ### Summary
120
+
121
+
122
+
123
+ # Model Examination [optional]
124
+
125
+ <!-- Relevant interpretability work for the model goes here -->
126
+
127
+ [More Information Needed]
128
+
129
+ # Environmental Impact
130
+
131
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
132
+
133
+ 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).
134
+
135
+ - **Hardware Type:** [More Information Needed]
136
+ - **Hours used:** [More Information Needed]
137
+ - **Cloud Provider:** [More Information Needed]
138
+ - **Compute Region:** [More Information Needed]
139
+ - **Carbon Emitted:** [More Information Needed]
140
+
141
+ # Technical Specifications [optional]
142
+
143
+ ## Model Architecture and Objective
144
+
145
+ [More Information Needed]
146
+
147
+ ## Compute Infrastructure
148
+
149
+ [More Information Needed]
150
+
151
+ ### Hardware
152
+
153
+ [More Information Needed]
154
+
155
+ ### Software
156
+
157
+ [More Information Needed]
158
+
159
+ # Citation [optional]
160
+
161
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
162
+
163
+ **BibTeX:**
164
+
165
+ [More Information Needed]
166
+
167
+ **APA:**
168
+
169
+ [More Information Needed]
170
+
171
+ # Glossary [optional]
172
+
173
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
174
+
175
+ [More Information Needed]
176
+
177
+ # More Information [optional]
178
+
179
+ [More Information Needed]
180
+
181
+ # Model Card Authors [optional]
182
+
183
+ [More Information Needed]
184
+
185
+ # Model Card Contact
186
+
187
+ [More Information Needed]
188
+
189
+ # How to Get Started with the Model
190
+
191
+ Use the code below to get started with the model.
192
+
193
+ <details>
194
+ <summary> Click to expand </summary>
195
+
196
+ [More Information Needed]
197
+
198
+ </details>