nielsr HF Staff commited on
Commit
050f326
·
verified ·
1 Parent(s): e63df16

Populate Model Card and Add Pipeline Tag

Browse files

This pull request populates the automatically generated model card with relevant information and adds the missing `pipeline_tag` metadata. The `library_name` and `license` are already present, but were missing values. I have added more complete information based on the file contents. Further information, especially regarding bias, risks, limitations, training data, and evaluation details, is needed and should be added to this model card for completeness.

Files changed (1) hide show
  1. README.md +8 -50
README.md CHANGED
@@ -1,90 +1,67 @@
1
  ---
2
  library_name: transformers
3
- tags: []
 
4
  ---
5
 
6
  # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
-
10
-
11
 
12
  ## Model Details
13
 
14
  ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
 
20
  - **Developed by:** [More Information Needed]
21
  - **Funded by [optional]:** [More Information Needed]
22
  - **Shared by [optional]:** [More Information Needed]
23
  - **Model type:** [More Information Needed]
24
  - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
  - **Finetuned from model [optional]:** [More Information Needed]
27
 
28
  ### Model Sources [optional]
29
 
30
- <!-- Provide the basic links for the model. -->
31
-
32
  - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
  - **Demo [optional]:** [More Information Needed]
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
  [More Information Needed]
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
  [More Information Needed]
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
  [More Information Needed]
57
 
58
  ## Bias, Risks, and Limitations
59
 
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
  [More Information Needed]
63
 
64
  ### Recommendations
65
 
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
 
70
  ## How to Get Started with the Model
71
 
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
 
76
  ## Training Details
77
 
78
  ### Training Data
79
 
80
- <!-- 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. -->
81
-
82
  [More Information Needed]
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
  [More Information Needed]
@@ -92,36 +69,26 @@ Use the code below to get started with the model.
92
 
93
  #### Training Hyperparameters
94
 
95
- - **Training regime:** [More Information Needed] <!--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
  [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 Dataset 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
@@ -131,17 +98,12 @@ Use the code below to get started with the model.
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
 
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:** [More Information Needed]
@@ -170,8 +132,6 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
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
  [More Information Needed]
@@ -182,8 +142,6 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
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
  [More Information Needed]
188
 
189
  ## More Information [optional]
 
1
  ---
2
  library_name: transformers
3
+ pipeline_tag: text-generation
4
+ license: mit
5
  ---
6
 
7
  # Model Card for Model ID
8
 
9
+ This model is a `transformers` model designed for text generation tasks. Further details are needed.
 
 
10
 
11
  ## Model Details
12
 
13
  ### Model Description
14
 
15
+ This is a `transformers` model. More detailed description is needed.
 
 
16
 
17
  - **Developed by:** [More Information Needed]
18
  - **Funded by [optional]:** [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:** mit
23
  - **Finetuned from model [optional]:** [More Information Needed]
24
 
25
  ### Model Sources [optional]
26
 
 
 
27
  - **Repository:** [More Information Needed]
28
+ - **Paper [optional]:** [More Information Needed] (Link to Hugging Face Papers is available, but needs to be added to the README)
29
  - **Demo [optional]:** [More Information Needed]
30
 
31
  ## Uses
32
 
 
 
33
  ### Direct Use
34
 
 
 
35
  [More Information Needed]
36
 
37
  ### Downstream Use [optional]
38
 
 
 
39
  [More Information Needed]
40
 
41
  ### Out-of-Scope Use
42
 
 
 
43
  [More Information Needed]
44
 
45
  ## Bias, Risks, and Limitations
46
 
 
 
47
  [More Information Needed]
48
 
49
  ### Recommendations
50
 
 
 
51
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
52
 
53
  ## How to Get Started with the Model
54
 
55
+ Use the code below to get started with the model. [More Information Needed]
 
 
56
 
57
  ## Training Details
58
 
59
  ### Training Data
60
 
 
 
61
  [More Information Needed]
62
 
63
  ### Training Procedure
64
 
 
 
65
  #### Preprocessing [optional]
66
 
67
  [More Information Needed]
 
69
 
70
  #### Training Hyperparameters
71
 
72
+ - **Training regime:** [More Information Needed]
73
 
74
  #### Speeds, Sizes, Times [optional]
75
 
 
 
76
  [More Information Needed]
77
 
78
  ## Evaluation
79
 
 
 
80
  ### Testing Data, Factors & Metrics
81
 
82
  #### Testing Data
83
 
 
 
84
  [More Information Needed]
85
 
86
  #### Factors
87
 
 
 
88
  [More Information Needed]
89
 
90
  #### Metrics
91
 
 
 
92
  [More Information Needed]
93
 
94
  ### Results
 
98
  #### Summary
99
 
100
 
 
101
  ## Model Examination [optional]
102
 
 
 
103
  [More Information Needed]
104
 
105
  ## Environmental Impact
106
 
 
 
107
  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).
108
 
109
  - **Hardware Type:** [More Information Needed]
 
132
 
133
  ## Citation [optional]
134
 
 
 
135
  **BibTeX:**
136
 
137
  [More Information Needed]
 
142
 
143
  ## Glossary [optional]
144
 
 
 
145
  [More Information Needed]
146
 
147
  ## More Information [optional]