Haowen Zhao commited on
Commit
091988c
1 Parent(s): 71a36e9

model card

Browse files
Files changed (2) hide show
  1. README.md +8 -0
  2. modelcard_template.md +0 -202
README.md CHANGED
@@ -1,3 +1,11 @@
 
 
 
 
 
 
 
 
1
  # Your Model Name
2
 
3
  ## Introduction
 
1
+ ---
2
+ language: protein
3
+ tags:
4
+ - protein language model
5
+ datasets:
6
+ - Uniref100
7
+ ---
8
+
9
  # Your Model Name
10
 
11
  ## Introduction
modelcard_template.md DELETED
@@ -1,202 +0,0 @@
1
- ---
2
- # For reference on model card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1
3
- # Doc / guide: https://huggingface.co/docs/hub/model-cards
4
- {{ card_data }}
5
- ---
6
-
7
- # Model Card for {{ model_id | default("Model ID", true) }}
8
-
9
- <!-- Provide a quick summary of what the model is/does. -->
10
-
11
- {{ model_summary | default("", true) }}
12
-
13
- ## Model Details
14
-
15
- ### Model Description
16
-
17
- <!-- Provide a longer summary of what this model is. -->
18
-
19
- {{ model_description | default("", true) }}
20
-
21
- - **Developed by:** {{ developers | default("[More Information Needed]", true)}}
22
- - **Shared by [optional]:** {{ shared_by | default("[More Information Needed]", true)}}
23
- - **Model type:** {{ model_type | default("[More Information Needed]", true)}}
24
- - **Language(s) (NLP):** {{ language | default("[More Information Needed]", true)}}
25
- - **License:** {{ license | default("[More Information Needed]", true)}}
26
- - **Finetuned from model [optional]:** {{ finetuned_from | default("[More Information Needed]", true)}}
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** {{ repo | default("[More Information Needed]", true)}}
33
- - **Paper [optional]:** {{ paper | default("[More Information Needed]", true)}}
34
- - **Demo [optional]:** {{ demo | default("[More Information Needed]", true)}}
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- {{ direct_use | default("[More Information Needed]", true)}}
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- {{ downstream_use | default("[More Information Needed]", true)}}
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- {{ out_of_scope_use | default("[More Information Needed]", true)}}
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- {{ bias_risks_limitations | default("[More Information Needed]", true)}}
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- {{ bias_recommendations | default("Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.", true)}}
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- {{ get_started_code | default("[More Information Needed]", true)}}
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- 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. -->
81
-
82
- {{ training_data | default("[More Information Needed]", true)}}
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- {{ preprocessing | default("[More Information Needed]", true)}}
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** {{ training_regime | default("[More Information Needed]", true)}} <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- {{ speeds_sizes_times | default("[More Information Needed]", true)}}
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
- {{ testing_data | default("[More Information Needed]", true)}}
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- {{ testing_factors | default("[More Information Needed]", true)}}
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- {{ testing_metrics | default("[More Information Needed]", true)}}
126
-
127
- ### Results
128
-
129
- {{ results | default("[More Information Needed]", true)}}
130
-
131
- #### Summary
132
-
133
- {{ results_summary | default("", true) }}
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- {{ model_examination | default("[More Information Needed]", true)}}
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- 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).
146
-
147
- - **Hardware Type:** {{ hardware | default("[More Information Needed]", true)}}
148
- - **Hours used:** {{ hours_used | default("[More Information Needed]", true)}}
149
- - **Cloud Provider:** {{ cloud_provider | default("[More Information Needed]", true)}}
150
- - **Compute Region:** {{ cloud_region | default("[More Information Needed]", true)}}
151
- - **Carbon Emitted:** {{ co2_emitted | default("[More Information Needed]", true)}}
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- {{ model_specs | default("[More Information Needed]", true)}}
158
-
159
- ### Compute Infrastructure
160
-
161
- {{ compute_infrastructure | default("[More Information Needed]", true)}}
162
-
163
- #### Hardware
164
-
165
- {{ hardware | default("[More Information Needed]", true)}}
166
-
167
- #### Software
168
-
169
- {{ software | default("[More Information Needed]", true)}}
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- {{ citation_bibtex | default("[More Information Needed]", true)}}
178
-
179
- **APA:**
180
-
181
- {{ citation_apa | default("[More Information Needed]", true)}}
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- {{ glossary | default("[More Information Needed]", true)}}
188
-
189
- ## More Information [optional]
190
-
191
- {{ more_information | default("[More Information Needed]", true)}}
192
-
193
- ## Model Card Authors [optional]
194
-
195
- {{ model_card_authors | default("[More Information Needed]", true)}}
196
-
197
- ## Model Card Contact
198
-
199
- {{ model_card_contact | default("[More Information Needed]", true)}}
200
-
201
-
202
-