Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating MC headings #1367

Merged
merged 1 commit into from
Feb 28, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 35 additions & 35 deletions src/huggingface_hub/templates/modelcard_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@

{{ model_summary | default("", true) }}

# Model Details
## Model Details

## Model Description
### Model Description

<!-- Provide a longer summary of what this model is. -->

Expand All @@ -25,120 +25,120 @@
- **License:** {{ license | default("[More Information Needed]", true)}}
- **Finetuned from model [optional]:** {{ finetuned_from | default("[More Information Needed]", true)}}

## Model Sources [optional]
### Model Sources [optional]

<!-- Provide the basic links for the model. -->

- **Repository:** {{ repo | default("[More Information Needed]", true)}}
- **Paper [optional]:** {{ paper | default("[More Information Needed]", true)}}
- **Demo [optional]:** {{ demo | default("[More Information Needed]", true)}}

# Uses
## 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
### 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]
### 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
### 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
## Bias, Risks, and Limitations

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

{{ bias_risks_limitations | default("[More Information Needed]", true)}}

## Recommendations
### 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 recommendations.", true)}}

## How to Get Started with the Model
### How to Get Started with the Model

Use the code below to get started with the model.

{{ get_started_code | default("[More Information Needed]", true)}}

# Training Details
## Training Details

## Training Data
### 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
### 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 [optional]
#### Preprocessing [optional]

{{ preprocessing | default("[More Information Needed]", true)}}


### Training Hyperparameters
#### Training Hyperparameters

- **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 -->

### Speeds, Sizes, Times [optional]
#### Speeds, Sizes, Times [optional]

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

{{ speeds_sizes_times | default("[More Information Needed]", true)}}

# Evaluation
## Evaluation

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

## Testing Data, Factors & Metrics
### Testing Data, Factors & Metrics

### Testing Data
#### Testing Data

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

{{ testing_data | default("[More Information Needed]", true)}}

### Factors
#### Factors

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

{{ testing_factors | default("[More Information Needed]", true)}}

### Metrics
#### Metrics

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

{{ testing_metrics | default("[More Information Needed]", true)}}

## Results
### Results

{{ results | default("[More Information Needed]", true)}}

### Summary
#### Summary

{{ results_summary | default("", true) }}

# Model Examination [optional]
## Model Examination [optional]

<!-- Relevant interpretability work for the model goes here -->

{{ model_examination | default("[More Information Needed]", true)}}

# Environmental Impact
## Environmental Impact

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

Expand All @@ -150,25 +150,25 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
- **Compute Region:** {{ cloud_region | default("[More Information Needed]", true)}}
- **Carbon Emitted:** {{ co2_emitted | default("[More Information Needed]", true)}}

# Technical Specifications [optional]
## Technical Specifications [optional]

## Model Architecture and Objective
### Model Architecture and Objective

{{ model_specs | default("[More Information Needed]", true)}}

## Compute Infrastructure
### Compute Infrastructure

{{ compute_infrastructure | default("[More Information Needed]", true)}}

### Hardware
#### Hardware

{{ hardware | default("[More Information Needed]", true)}}

### Software
#### Software

{{ software | default("[More Information Needed]", true)}}

# Citation [optional]
## Citation [optional]

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

Expand All @@ -180,21 +180,21 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]

{{ citation_apa | default("[More Information Needed]", true)}}

# Glossary [optional]
## 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 [optional]

{{ more_information | default("[More Information Needed]", true)}}

# Model Card Authors [optional]
## Model Card Authors [optional]

{{ model_card_authors | default("[More Information Needed]", true)}}

# Model Card Contact
## Model Card Contact

{{ model_card_contact | default("[More Information Needed]", true)}}

Expand Down