modelcard_template_new_spec.md

metadata

'[object Object]': null

{{ model_id }}

<!--> Provide a quick summary of what the model is/does. <!-->

Table of Contents

• {{ model_id }}
• Table of Contents
• Model Details
  • Model Description
• Uses
  • Direct Use
  • Downstream Use [Optional]
  • Out-of-Scope Use
• Bias, Risks, and Limitations
  • Recommendations
• Training Details
  • Training Data
  • Training Procedure
    • Preprocessing
    • Speeds, Sizes, Times
• Evaluation
  • Testing Data, Factors & Metrics
    • Testing Data
    • Factors
    • Metrics
  • Results
• Model Examination
• Environmental Impact
• Technical Specifications [optional]
  • Model Architecture and Objective
  • Compute Infrastructure
    • Hardware
    • Software
• Citation
• Glossary [optional]
• More Information [optional]
• Model Card Authors [optional]
• Model Card Contact
• How to Get Started with the Model

Model Details

Model Description

<!--> Provide a longer summary of what this model is. <!--> {{ the_model_description | default("More information needed", true)}}

• Developed by: {{ developers | default("More information needed", true)}}
• Shared by [Optional]: {{ shared_by | default("More information needed", true)}}
• Model type: Language model
• Language(s) (NLP): {{ language | default("More information needed", true)}}
• License: {{ license | default("More information needed", true)}}
• Related Models: {{ related_models | join(', ') | default("More information needed", true)}} {{ " - Parent Model".format(repo_link) if parent_model_link }}
• Resources for more information: {{ more_resources | default("More information needed", true)}} {{ " - GitHub Repo".format(repo_link) if repo_link }} {{ " - Associated Paper".format(paper_link) if paper_link }} {{ " - Blog Post".format(blog_link) if blog_link }}

Uses

<!--> Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. <!-->

Direct Use

<!--> This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. <!-->

{{ direct_use | default("More information needed", true)}}

Downstream Use [Optional]

<!--> This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app <!-->

{{ downstream_use | default("More information needed", true)}}

Out-of-Scope Use

<!--> This section addresses misuse, malicious use, and uses that the model will not work well for. <!-->

{{ out_of_scope_use | default("More information needed", true)}}

Bias, Risks, and Limitations

<!--> This section is meant to convey both technical and sociotechnical limitations. <!-->

{{ bias_risks_limitations | default("More information needed", true)}}

Recommendations

<!--> This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. <!-->

{{ 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 recomendations.", true)}}

Training Details

Training Data

<!--> 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. <!-->

{{ training_data | default("More information needed", true)}}

Training Procedure

<!--> This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. <!-->

Preprocessing

{{ preprocessing | default("More information needed", true)}}

Speeds, Sizes, Times

<!--> This section provides information about throughput, start/end time, checkpoint size if relevant, etc. <!-->

{{ speeds_sizes_times | default("More information needed", true)}}

Evaluation

<!--> This section describes the evaluation protocols and provides the results. <!-->

Testing Data, Factors & Metrics

Testing Data

<!--> This should link to a Data Card if possible. <!-->

{{ testing_data | default("More information needed", true)}}

Factors

<!--> These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. <!-->

{{ testing_factors | default("More information needed", true)}}

Metrics

<!--> These are the evaluation metrics being used, ideally with a description of why. <!-->

{{ testing_metrics | default("More information needed", true)}}

Results

{{ results | default("More information needed", true)}}

Model Examination

{{ model_examination | default("More information needed", true)}}

Environmental Impact

<!--> Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly <!-->

Carbon emissions can be estimated using the Machine Learning Impact calculator presented in Lacoste et al. (2019).

• Hardware Type: {{ hardware | default("More information needed", true)}}
• Hours used: {{ hours_used | default("More information needed", true)}}
• Cloud Provider: {{ cloud_provider | default("More information needed", true)}}
• Compute Region: {{ cloud_region | default("More information needed", true)}}
• Carbon Emitted: {{ co2_emitted | default("More information needed", true)}}

Technical Specifications [optional]

Model Architecture and Objective

{{ model_specs | default("More information needed", true)}}

Compute Infrastructure

{{ compute_infrastructure | default("More information needed", true)}}

Hardware

{{ hardware | default("More information needed", true)}}

Software

{{ software | default("More information needed", true)}}

Citation

<!--> If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. <!-->

BibTeX:

{{ citation_bibtex | default("More information needed", true)}}

APA:

{{ citation_apa | default("More information needed", true)}}

Glossary [optional]

<!--> If relevant, include terms and calculations in this section that can help readers understand the model or model card. <!-->

{{ glossary | default("More information needed", true)}}

More Information [optional]

{{ more_information | default("More information needed", true)}}

Model Card Authors [optional]

{{ model_card_authors | default("More information needed", true)}}

Model Card Contact

{{ model_card_contact | default("More information needed", true)}}

How to Get Started with the Model

Use the code below to get started with the model.

Click to expand

{{ get_started_code | default("More information needed", true)}}