exzread commited on
Commit
ad14de2
1 Parent(s): 3656a5c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +219 -0
README.md CHANGED
@@ -1,3 +1,222 @@
1
  ---
2
  license: apache-2.0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
+ datasets:
4
+ - math-ai/AutoMathText
5
+ - argilla/distilabel-capybara-dpo-7k-binarized
6
+ - teknium/OpenHermes-2.5
7
+ - fka/awesome-chatgpt-prompts
8
+ - allenai/dolma
9
+ - HuggingFaceM4/WebSight
10
+ - litagin/moe-speech
11
+ - Locutusque/UltraTextbooks
12
+ language:
13
+ - id
14
+ metrics:
15
+ - accuracy
16
+ - code_eval
17
+ - character
18
+ - bertscore
19
+ - brier_score
20
+ library_name: adapter-transformers
21
+ pipeline_tag: text-generation
22
+ tags:
23
+ - legal
24
+ - medical
25
+ - code
26
+ - biology
27
+ - finance
28
  ---
29
+ # Model Card for Model ID
30
+
31
+ <!-- Provide a quick summary of what the model is/does. -->
32
+
33
+ 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).
34
+
35
+ ## Model Details
36
+
37
+ ### Model Description
38
+
39
+ <!-- Provide a longer summary of what this model is. -->
40
+
41
+
42
+
43
+ - **Developed by:** [More Information Needed]
44
+ - **Funded by [optional]:** [More Information Needed]
45
+ - **Shared by [optional]:** [More Information Needed]
46
+ - **Model type:** [More Information Needed]
47
+ - **Language(s) (NLP):** [More Information Needed]
48
+ - **License:** [More Information Needed]
49
+ - **Finetuned from model [optional]:** [More Information Needed]
50
+
51
+ ### Model Sources [optional]
52
+
53
+ <!-- Provide the basic links for the model. -->
54
+
55
+ - **Repository:** [More Information Needed]
56
+ - **Paper [optional]:** [More Information Needed]
57
+ - **Demo [optional]:** [More Information Needed]
58
+
59
+ ## Uses
60
+
61
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
62
+
63
+ ### Direct Use
64
+
65
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
66
+
67
+ [More Information Needed]
68
+
69
+ ### Downstream Use [optional]
70
+
71
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
72
+
73
+ [More Information Needed]
74
+
75
+ ### Out-of-Scope Use
76
+
77
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
78
+
79
+ [More Information Needed]
80
+
81
+ ## Bias, Risks, and Limitations
82
+
83
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
84
+
85
+ [More Information Needed]
86
+
87
+ ### Recommendations
88
+
89
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
90
+
91
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
92
+
93
+ ## How to Get Started with the Model
94
+
95
+ Use the code below to get started with the model.
96
+
97
+ [More Information Needed]
98
+
99
+ ## Training Details
100
+
101
+ ### Training Data
102
+
103
+ <!-- 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. -->
104
+
105
+ [More Information Needed]
106
+
107
+ ### Training Procedure
108
+
109
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
110
+
111
+ #### Preprocessing [optional]
112
+
113
+ [More Information Needed]
114
+
115
+
116
+ #### Training Hyperparameters
117
+
118
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
119
+
120
+ #### Speeds, Sizes, Times [optional]
121
+
122
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
123
+
124
+ [More Information Needed]
125
+
126
+ ## Evaluation
127
+
128
+ <!-- This section describes the evaluation protocols and provides the results. -->
129
+
130
+ ### Testing Data, Factors & Metrics
131
+
132
+ #### Testing Data
133
+
134
+ <!-- This should link to a Dataset Card if possible. -->
135
+
136
+ [More Information Needed]
137
+
138
+ #### Factors
139
+
140
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
141
+
142
+ [More Information Needed]
143
+
144
+ #### Metrics
145
+
146
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
147
+
148
+ [More Information Needed]
149
+
150
+ ### Results
151
+
152
+ [More Information Needed]
153
+
154
+ #### Summary
155
+
156
+
157
+
158
+ ## Model Examination [optional]
159
+
160
+ <!-- Relevant interpretability work for the model goes here -->
161
+
162
+ [More Information Needed]
163
+
164
+ ## Environmental Impact
165
+
166
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
167
+
168
+ 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).
169
+
170
+ - **Hardware Type:** [More Information Needed]
171
+ - **Hours used:** [More Information Needed]
172
+ - **Cloud Provider:** [More Information Needed]
173
+ - **Compute Region:** [More Information Needed]
174
+ - **Carbon Emitted:** [More Information Needed]
175
+
176
+ ## Technical Specifications [optional]
177
+
178
+ ### Model Architecture and Objective
179
+
180
+ [More Information Needed]
181
+
182
+ ### Compute Infrastructure
183
+
184
+ [More Information Needed]
185
+
186
+ #### Hardware
187
+
188
+ [More Information Needed]
189
+
190
+ #### Software
191
+
192
+ [More Information Needed]
193
+
194
+ ## Citation [optional]
195
+
196
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
197
+
198
+ **BibTeX:**
199
+
200
+ [More Information Needed]
201
+
202
+ **APA:**
203
+
204
+ [More Information Needed]
205
+
206
+ ## Glossary [optional]
207
+
208
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
209
+
210
+ [More Information Needed]
211
+
212
+ ## More Information [optional]
213
+
214
+ [More Information Needed]
215
+
216
+ ## Model Card Authors [optional]
217
+
218
+ [More Information Needed]
219
+
220
+ ## Model Card Contact
221
+
222
+ [More Information Needed]