nazneen commited on
Commit
369512c
1 Parent(s): e954ab0

model documentation

Browse files
Files changed (1) hide show
  1. README.md +173 -0
README.md ADDED
@@ -0,0 +1,173 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ tags:
4
+ - gpt2
5
+ - text-generation
6
+ ---
7
+
8
+ # Model Card for alias-gpt2-small-x21
9
+
10
+ # Model Details
11
+
12
+ ## Model Description
13
+
14
+ More information needed
15
+
16
+ - **Developed by:** Stanford CRFM
17
+ - **Shared by [Optional]:** Stanford CRFM
18
+
19
+ - **Model type:** Text Generation
20
+ - **Language(s) (NLP):** More information needed
21
+ - **License:** Apache 2.0
22
+ - **Parent Model:** [GPT-2](https://huggingface.co/gpt2?text=My+name+is+Thomas+and+my+main)
23
+ - **Resources for more information:**
24
+ - [GitHub Repo](https://github.com/stanford-crfm/mistral)
25
+
26
+
27
+
28
+ # Uses
29
+
30
+
31
+ ## Direct Use
32
+ This model can be used for the task of Text Generation.
33
+
34
+ ## Downstream Use [Optional]
35
+
36
+ More information needed.
37
+
38
+ ## Out-of-Scope Use
39
+
40
+ The model should not be used to intentionally create hostile or alienating environments for people.
41
+
42
+ # Bias, Risks, and Limitations
43
+
44
+
45
+ Significant research has explored bias and fairness issues with language models (see, e.g., [Sheng et al. (2021)](https://aclanthology.org/2021.acl-long.330.pdf) and [Bender et al. (2021)](https://dl.acm.org/doi/pdf/10.1145/3442188.3445922)). Predictions generated by the model may include disturbing and harmful stereotypes across protected classes; identity characteristics; and sensitive, social, and occupational groups.
46
+
47
+
48
+
49
+ ## Recommendations
50
+
51
+
52
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
53
+
54
+ # Training Details
55
+
56
+ ## Training Data
57
+
58
+ More information needed
59
+
60
+ ## Training Procedure
61
+
62
+
63
+ ### Preprocessing
64
+
65
+ More information needed
66
+
67
+
68
+
69
+ ### Speeds, Sizes, Times
70
+
71
+ More information needed
72
+
73
+
74
+
75
+ # Evaluation
76
+
77
+
78
+ ## Testing Data, Factors & Metrics
79
+
80
+ ### Testing Data
81
+
82
+ More information needed
83
+
84
+ ### Factors
85
+ More information needed
86
+
87
+ ### Metrics
88
+
89
+ More information needed
90
+
91
+
92
+ ## Results
93
+
94
+ More information needed
95
+
96
+
97
+ # Model Examination
98
+
99
+ More information needed
100
+
101
+ # Environmental Impact
102
+
103
+ 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).
104
+
105
+ - **Hardware Type:** More information needed
106
+ - **Hours used:** More information needed
107
+ - **Cloud Provider:** More information needed
108
+ - **Compute Region:** More information needed
109
+ - **Carbon Emitted:** More information needed
110
+
111
+ # Technical Specifications [optional]
112
+
113
+ ## Model Architecture and Objective
114
+
115
+ More information needed
116
+
117
+ ## Compute Infrastructure
118
+
119
+ More information needed
120
+
121
+ ### Hardware
122
+
123
+
124
+ More information needed
125
+
126
+ ### Software
127
+
128
+ More information needed.
129
+
130
+ # Citation
131
+
132
+
133
+ **BibTeX:**
134
+
135
+ More information needed
136
+
137
+
138
+
139
+
140
+ **APA:**
141
+
142
+ More information needed
143
+
144
+ # Glossary [optional]
145
+
146
+ More information needed
147
+
148
+ # More Information [optional]
149
+ More information needed
150
+
151
+ # Model Card Authors [optional]
152
+
153
+ Stanford CRFM in collaboration with Ezi Ozoani and the Hugging Face team
154
+
155
+ # Model Card Contact
156
+
157
+ More information needed
158
+
159
+ # How to Get Started with the Model
160
+
161
+ Use the code below to get started with the model.
162
+
163
+ <details>
164
+ <summary> Click to expand </summary>
165
+
166
+ ```python
167
+ from transformers import AutoTokenizer, AutoModelForCausalLM
168
+
169
+ tokenizer = AutoTokenizer.from_pretrained("stanford-crfm/alias-gpt2-small-x21")
170
+
171
+ model = AutoModelForCausalLM.from_pretrained("stanford-crfm/alias-gpt2-small-x21")
172
+ ```
173
+ </details>