Improve model card with metadata and information
Browse filesThis PR adds a proper model card with relevant metadata and fills in the missing information from the template. It includes the pipeline tag, library name, and license. It also provides a basic model description and usage example. Further details can be added later.
README.md
CHANGED
|
@@ -1,90 +1,69 @@
|
|
| 1 |
---
|
| 2 |
library_name: transformers
|
| 3 |
-
|
|
|
|
| 4 |
---
|
| 5 |
|
| 6 |
# Model Card for Model ID
|
| 7 |
|
| 8 |
-
|
| 9 |
-
|
| 10 |
|
| 11 |
|
| 12 |
## Model Details
|
| 13 |
|
| 14 |
### Model Description
|
| 15 |
|
| 16 |
-
|
| 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:**
|
| 24 |
- **Language(s) (NLP):** [More Information Needed]
|
| 25 |
-
- **License:**
|
| 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 +71,26 @@ Use the code below to get started with the model.
|
|
| 92 |
|
| 93 |
#### Training Hyperparameters
|
| 94 |
|
| 95 |
-
- **Training regime:** [More Information Needed]
|
| 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
|
|
@@ -134,14 +103,10 @@ Use the code below to get started with the model.
|
|
| 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 +135,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 +145,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 text generation model. Further details will be added soon.
|
|
|
|
| 10 |
|
| 11 |
|
| 12 |
## Model Details
|
| 13 |
|
| 14 |
### Model Description
|
| 15 |
|
| 16 |
+
This is a text generation model developed using the Transformers library. More details on the model architecture and training specifics will be added soon.
|
| 17 |
|
|
|
|
| 18 |
|
| 19 |
- **Developed by:** [More Information Needed]
|
| 20 |
- **Funded by [optional]:** [More Information Needed]
|
| 21 |
- **Shared by [optional]:** [More Information Needed]
|
| 22 |
+
- **Model type:** Text Generation
|
| 23 |
- **Language(s) (NLP):** [More Information Needed]
|
| 24 |
+
- **License:** MIT
|
| 25 |
- **Finetuned from model [optional]:** [More Information Needed]
|
| 26 |
|
| 27 |
### Model Sources [optional]
|
| 28 |
|
|
|
|
|
|
|
| 29 |
- **Repository:** [More Information Needed]
|
| 30 |
+
- **Paper [optional]:** [More Information Needed] (Link to Hugging Face paper page)
|
| 31 |
- **Demo [optional]:** [More Information Needed]
|
| 32 |
|
| 33 |
## Uses
|
| 34 |
|
|
|
|
|
|
|
| 35 |
### Direct Use
|
| 36 |
|
|
|
|
|
|
|
| 37 |
[More Information Needed]
|
| 38 |
|
| 39 |
### Downstream Use [optional]
|
| 40 |
|
|
|
|
|
|
|
| 41 |
[More Information Needed]
|
| 42 |
|
| 43 |
### Out-of-Scope Use
|
| 44 |
|
|
|
|
|
|
|
| 45 |
[More Information Needed]
|
| 46 |
|
| 47 |
## Bias, Risks, and Limitations
|
| 48 |
|
|
|
|
|
|
|
| 49 |
[More Information Needed]
|
| 50 |
|
| 51 |
### Recommendations
|
| 52 |
|
|
|
|
|
|
|
| 53 |
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
| 54 |
|
| 55 |
## How to Get Started with the Model
|
| 56 |
|
| 57 |
+
Use the code below to get started with the model. (Add a code snippet here)
|
|
|
|
|
|
|
| 58 |
|
| 59 |
## Training Details
|
| 60 |
|
| 61 |
### Training Data
|
| 62 |
|
|
|
|
|
|
|
| 63 |
[More Information Needed]
|
| 64 |
|
| 65 |
### Training Procedure
|
| 66 |
|
|
|
|
|
|
|
| 67 |
#### Preprocessing [optional]
|
| 68 |
|
| 69 |
[More Information Needed]
|
|
|
|
| 71 |
|
| 72 |
#### Training Hyperparameters
|
| 73 |
|
| 74 |
+
- **Training regime:** [More Information Needed]
|
| 75 |
|
| 76 |
#### Speeds, Sizes, Times [optional]
|
| 77 |
|
|
|
|
|
|
|
| 78 |
[More Information Needed]
|
| 79 |
|
| 80 |
## Evaluation
|
| 81 |
|
|
|
|
|
|
|
| 82 |
### Testing Data, Factors & Metrics
|
| 83 |
|
| 84 |
#### Testing Data
|
| 85 |
|
|
|
|
|
|
|
| 86 |
[More Information Needed]
|
| 87 |
|
| 88 |
#### Factors
|
| 89 |
|
|
|
|
|
|
|
| 90 |
[More Information Needed]
|
| 91 |
|
| 92 |
#### Metrics
|
| 93 |
|
|
|
|
|
|
|
| 94 |
[More Information Needed]
|
| 95 |
|
| 96 |
### Results
|
|
|
|
| 103 |
|
| 104 |
## Model Examination [optional]
|
| 105 |
|
|
|
|
|
|
|
| 106 |
[More Information Needed]
|
| 107 |
|
| 108 |
## Environmental Impact
|
| 109 |
|
|
|
|
|
|
|
| 110 |
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).
|
| 111 |
|
| 112 |
- **Hardware Type:** [More Information Needed]
|
|
|
|
| 135 |
|
| 136 |
## Citation [optional]
|
| 137 |
|
|
|
|
|
|
|
| 138 |
**BibTeX:**
|
| 139 |
|
| 140 |
[More Information Needed]
|
|
|
|
| 145 |
|
| 146 |
## Glossary [optional]
|
| 147 |
|
|
|
|
|
|
|
| 148 |
[More Information Needed]
|
| 149 |
|
| 150 |
## More Information [optional]
|