zchflyer commited on
Commit
fe56bbd
1 Parent(s): e1a134e

Update README.md

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