ColleenMacklin commited on
Commit
91b40ad
·
1 Parent(s): b0956d4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -158
README.md CHANGED
@@ -16,127 +16,28 @@ co2_eq_emissions:
16
  This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
17
 
18
  # Model Details
 
 
19
 
20
  ## Model Description
21
 
22
  <!-- Provide a longer summary of what this model is. -->
 
 
23
 
24
-
25
-
26
- - **Developed by:** [More Information Needed]
27
- - **Shared by [optional]:** [More Information Needed]
28
- - **Model type:** [More Information Needed]
29
- - **Language(s) (NLP):** [More Information Needed]
30
  - **License:** [More Information Needed]
31
- - **Finetuned from model [optional]:** [More Information Needed]
32
-
33
- ## Model Sources [optional]
34
-
35
- <!-- Provide the basic links for the model. -->
36
-
37
- - **Repository:** [More Information Needed]
38
- - **Paper [optional]:** [More Information Needed]
39
- - **Demo [optional]:** [More Information Needed]
40
 
41
  # Uses
42
 
43
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
44
-
45
- ## Direct Use
46
-
47
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
48
-
49
- [More Information Needed]
50
-
51
- ## Downstream Use [optional]
52
-
53
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
54
-
55
- [More Information Needed]
56
-
57
- ## Out-of-Scope Use
58
-
59
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
60
-
61
- [More Information Needed]
62
 
63
  # Bias, Risks, and Limitations
64
 
65
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
66
-
67
- [More Information Needed]
68
-
69
- ## Recommendations
70
-
71
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
72
-
73
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
74
-
75
- ## How to Get Started with the Model
76
-
77
- Use the code below to get started with the model.
78
-
79
- [More Information Needed]
80
-
81
- # Training Details
82
-
83
- ## Training Data
84
-
85
- <!-- 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. -->
86
-
87
- [More Information Needed]
88
-
89
- ## Training Procedure [optional]
90
-
91
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
92
-
93
- ### Preprocessing
94
-
95
- [More Information Needed]
96
-
97
- ### Speeds, Sizes, Times
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 Data 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
 
@@ -160,52 +61,3 @@ co2_eq_emissions:
160
  - **Compute Region:** [Brooklyn, NY, USA]
161
  - **Carbon Emitted:** [.05kg Co2 eq.]
162
 
163
- # Technical Specifications [optional]
164
-
165
- ## Model Architecture and Objective
166
-
167
- [More Information Needed]
168
-
169
- ## Compute Infrastructure
170
-
171
- [More Information Needed]
172
-
173
- ### Hardware
174
-
175
- [More Information Needed]
176
-
177
- ### Software
178
-
179
- [More Information Needed]
180
-
181
- # Citation [optional]
182
-
183
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
184
-
185
- **BibTeX:**
186
-
187
- [More Information Needed]
188
-
189
- **APA:**
190
-
191
- [More Information Needed]
192
-
193
- # Glossary [optional]
194
-
195
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
196
-
197
- [More Information Needed]
198
-
199
- # More Information [optional]
200
-
201
- [More Information Needed]
202
-
203
- # Model Card Authors [optional]
204
-
205
- [More Information Needed]
206
-
207
- # Model Card Contact
208
-
209
- [More Information Needed]
210
-
211
-
 
16
  This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
17
 
18
  # Model Details
19
+ Finetuned using aitextgen, an easy-to-use library by Max Woolf for creative text generation.
20
+ more here: https://github.com/minimaxir/aitextgen
21
 
22
  ## Model Description
23
 
24
  <!-- Provide a longer summary of what this model is. -->
25
+ finetuned using aitextgen on a dataset including philosophy books, r/showerthoughts, and original texts generated by chatGPT.
26
+ Please report any offensive content, etc!
27
 
28
+ - **Developed by:** Colleen Macklin
29
+ - **Model type:** GPT Neo Small (125m)
30
+ - **Language(s) (NLP):** en
 
 
 
31
  - **License:** [More Information Needed]
32
+ - **Finetuned from model [optional]:** GPT Neo Small (125m)
 
 
 
 
 
 
 
 
33
 
34
  # Uses
35
 
36
+ For creative projects and dialogue generation.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
37
 
38
  # Bias, Risks, and Limitations
39
 
40
+ This model generates unsupervised random output has the potential to offend with biased outputs. Please use responsibly.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
41
 
42
  # Environmental Impact
43
 
 
61
  - **Compute Region:** [Brooklyn, NY, USA]
62
  - **Carbon Emitted:** [.05kg Co2 eq.]
63