Upload README.md with huggingface_hub

README.md

@@ -10,9 +10,9 @@
 
 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).
 
-# Model Details
+## Model Details
 
-## Model Description
+### Model Description
 
 <!-- Provide a longer summary of what this model is. -->
 
@@ -25,7 +25,7 @@ This modelcard aims to be a base template for new models. It has been generated
 - **License:** [More Information Needed]
 - **Finetuned from model [optional]:** [More Information Needed]
 
-## Model Sources [optional]
+### Model Sources [optional]
 
 <!-- Provide the basic links for the model. -->
 
@@ -33,112 +33,112 @@ This modelcard aims to be a base template for new models. It has been generated
 - **Paper [optional]:** [More Information Needed]
 - **Demo [optional]:** [More Information Needed]
 
-# 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. -->
 
 [More Information Needed]
 
-## 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 -->
 
 [More Information Needed]
 
-## Out-of-Scope Use
+### Out-of-Scope Use
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
 [More Information Needed]
 
-# Bias, Risks, and Limitations
+## Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
 [More Information Needed]
 
-## Recommendations
+### Recommendations
 
 <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
 
 Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
-## How to Get Started with the Model
+### How to Get Started with the Model
 
 Use the code below to get started with the model.
 
 [More Information Needed]
 
-# 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. -->
 
 [More Information Needed]
 
-## 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]
 
 [More Information Needed]
 
 
-### Training Hyperparameters
+#### Training Hyperparameters
 
 - **Training regime:** [More Information Needed] <!--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. -->
 
 [More Information Needed]
 
-# 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. -->
 
 [More Information Needed]
 
-### Factors
+#### Factors
 
 <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
 
 [More Information Needed]
 
-### Metrics
+#### Metrics
 
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
 [More Information Needed]
 
-## Results
+### Results
 
 [More Information Needed]
 
-### Summary
+#### Summary
 
 
 
-# Model Examination [optional]
+## Model Examination [optional]
 
 <!-- Relevant interpretability work for the model goes here -->
 
 [More Information Needed]
 
-# 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 -->
 
@@ -150,25 +150,25 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 - **Compute Region:** [More Information Needed]
 - **Carbon Emitted:** [More Information Needed]
 
-# Technical Specifications [optional]
+## Technical Specifications [optional]
 
-## Model Architecture and Objective
+### Model Architecture and Objective
 
 [More Information Needed]
 
-## Compute Infrastructure
+### Compute Infrastructure
 
 [More Information Needed]
 
-### Hardware
+#### Hardware
 
 [More Information Needed]
 
-### Software
+#### Software
 
 [More Information Needed]
 
-# 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. -->
 
@@ -180,21 +180,21 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 [More Information Needed]
 
-# Glossary [optional]
+## Glossary [optional]
 
 <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
 [More Information Needed]
 
-# More Information [optional]
+## More Information [optional]
 
 [More Information Needed]
 
-# Model Card Authors [optional]
+## Model Card Authors [optional]
 
 [More Information Needed]
 
-# Model Card Contact
+## Model Card Contact
 
 [More Information Needed]