Add base model metadata to model card

[BenjaminBossan]

Resolves #938

This PR adds the base model metadata, if present, to the model card.

On top of this, the code for creating the model card has been refactored to use the huggingface_hub classes instead of doing ad hoc parsing and writing. A consequence of this is that if no model card exists, the default template will now be used, with a lot of placeholder text.

LMK if this is not desired.

ping @davanstrien @osanseviero

[HuggingFaceDocBuilderDev]

The documentation is not available anymore as the PR was closed or merged.

[BenjaminBossan]

Below is an exemplary model card being created for OPT with the new changes. Note all the placeholder text being added:

---
library_name: peft
base_model: hf-internal-testing/tiny-random-OPTForCausalLM
---

# Model Card for Model ID

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



## Model Details

### Model Description

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



- **Developed by:** [More Information Needed]
- **Shared by [optional]:** [More Information Needed]
- **Model type:** [More Information Needed]
- **Language(s) (NLP):** [More Information Needed]
- **License:** [More Information Needed]
- **Finetuned from model [optional]:** [More Information Needed]

### Model Sources [optional]

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

- **Repository:** [More Information Needed]
- **Paper [optional]:** [More Information Needed]
- **Demo [optional]:** [More Information Needed]

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

[More Information Needed]

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

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

[More Information Needed]

## Bias, Risks, and Limitations

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

[More Information Needed]

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

Use the code below to get started with the model.

[More Information Needed]

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

[More Information Needed]

### 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]

[More Information Needed]


#### 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]

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

[More Information Needed]

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

[More Information Needed]

#### Factors

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

[More Information Needed]

#### Metrics

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

[More Information Needed]

### Results

[More Information Needed]

#### Summary



## Model Examination [optional]

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

[More Information Needed]

## 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](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).

- **Hardware Type:** [More Information Needed]
- **Hours used:** [More Information Needed]
- **Cloud Provider:** [More Information Needed]
- **Compute Region:** [More Information Needed]
- **Carbon Emitted:** [More Information Needed]

## Technical Specifications [optional]

### Model Architecture and Objective

[More Information Needed]

### Compute Infrastructure

[More Information Needed]

#### Hardware

[More Information Needed]

#### Software

[More Information Needed]

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

**BibTeX:**

[More Information Needed]

**APA:**

[More Information Needed]

## 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 Needed]

## Model Card Authors [optional]

[More Information Needed]

## Model Card Contact

[More Information Needed]


## Training procedure


### Framework versions


- PEFT 0.6.0.dev0

[davanstrien]

Thanks for working on this.

A consequence of this is that if no model card exists, the default template will now be used with a lot of placeholder text.

I think this is fine. Obviously, we hope that users will fill this in eventually.

It might also make sense just to add a brief section at the top of the model card that is library-specific. i.e. something like This model was trained using [peft](link)a library that enables you to...`. I think this context can be helpful and also gives people a better idea of where to go for guidance on using the model outside of the model card.

[BenjaminBossan]

It might also make sense just to add a brief section at the top of the model card that is library-specific

At the bottom, we have ### Framework versions - PEFT 0.6.0.dev0. Would you want to move that to the top instead, or have two entries?

[osanseviero]

cc @Wauplin

[davanstrien]

It might also make sense just to add a brief section at the top of the model card that is library-specific

At the bottom, we have ### Framework versions - PEFT 0.6.0.dev0. Would you want to move that to the top instead, or have two entries?

What I am thinking of is more of a basic overview of the library in one sentence. i.e. something a little more like the SpanMarker entry.

This is a [SpanMarker](https://github.com/tomaarsen/SpanMarkerNER) model trained on the [Inspec](https://huggingface.co/datasets/midas/inspec) dataset that can be used for Named Entity Recognition. source

Maybe something like:

This is a model trained using the [PEFT library](https://github.com/huggingface/peft), which facilitates the efficient adaptation of pre-trained language models to various downstream applications without the necessity of fine-tuning all the model's parameters​

I think this is helpful context for someone who arrives at the model card without knowing anything about the PEFT library/approaches. Probably some people will remove it, but if people don't modify the standard model card, this gives a little bit more context for how the model was created.

[Wauplin]

Thanks for the ping @osanseviero :)

I quickly reviewed the implementation and I think it can be slightly simplified to let huggingface_hub do the parsing if there is an existing model card in the folder. Otherwise, really glad to see it adopted like this! 😃

A consequence of this is that if no model card exists, the default template will now be used with a lot of placeholder text.
I think this is fine. Obviously, we hope that users will fill this in eventually.

I also agree with @davanstrien than it will probably encourage more to complete the model card rather than being problematic.

[BenjaminBossan]

@Wauplin Thanks for the simplification, I was wondering if this functionality existed, but somehow missed it in the docs.

@davanstrien Would you be fine with adding that extra information in a separate PR, so as to keep this one focused?

[davanstrien]

@davanstrien Would you be fine with adding that extra information in a separate PR, so as to keep this one focused?

Sure :)

[younesbelkada]

Thanks @BenjaminBossan ! The changes look great to me if you want to merge the PR as it is.

[pacman100]

Thank you @BenjaminBossan for fixing the model card when using PEFT and adding the base model information. 🤗