README.md

---
size_categories:
- 100K<n<1M
task_categories:
- text-retrieval
pretty_name: Hugging Face Hub Model Cards
dataset_info:
  features:
  - name: modelId
    dtype: string
  - name: author
    dtype: string
  - name: last_modified
    dtype: timestamp[us, tz=UTC]
  - name: downloads
    dtype: int64
  - name: likes
    dtype: int64
  - name: library_name
    dtype: string
  - name: tags
    sequence: string
  - name: pipeline_tag
    dtype: string
  - name: createdAt
    dtype: timestamp[us, tz=UTC]
  - name: card
    dtype: string
  splits:
  - name: train
    num_bytes: 1111084228
    num_examples: 598568
  download_size: 330372018
  dataset_size: 1111084228
configs:
- config_name: default
  data_files:
  - split: train
    path: data/train-*
tags:
- ethics
---

# Dataset Card for Hugging Face Hub Model Cards

This datasets consists of [model cards](https://huggingface.co/docs/hub/model-cards) for models hosted on the Hugging Face Hub. The model cards are created by the community and provide information about the model, its performance, its intended uses, and more. 
This dataset is updated on a daily basis and includes publicly available models on the Hugging Face Hub.

This dataset is made available to help support users wanting to work with a large number of Model Cards from the Hub. We hope that this dataset will help support research in the area of Model Cards and their use but the format of this dataset may not be useful for all use cases. If there are other features that you would like to see included in this dataset, please open a new [discussion](https://huggingface.co/datasets/librarian-bots/model_cards_with_metadata/discussions/new). 

## Dataset Details

### Dataset Description


- **Curated by:** Daniel van Strien
- **Language(s) (NLP):** Model cards on the Hugging Face Hub are predominantly in English but may include other languages.
  

## Uses

There are a number of potential uses for this dataset including:
- text mining to find common themes in model cards
- analysis of the model card format/content
- topic modelling of model cards
- analysis of the model card metadata
- training language models on model cards


### Out-of-Scope Use


[More Information Needed]

## Dataset Structure

This dataset has a single split.

## Dataset Creation

### Curation Rationale

<!-- Motivation for the creation of this dataset. -->

The dataset was created to assist people in working with model cards. In particular it was created to support research in the area of model cards and their use. It is possible to use the Hugging Face Hub API or client library to download model cards and this option may be preferable if you have a very specific use case or require a different format.

### Source Data

The source data is `README.md` files for models hosted on the Hugging Face Hub. We do not include any other supplementary files that may be included in the model card directory. 

#### Data Collection and Processing

<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->

The data is downloaded using a CRON job on a daily basis. 

#### Who are the source data producers?

The source data producers are the creators of the model cards on the Hugging Face Hub. This includes a broad variety of people from the community ranging from large companies to individual researchers. We do not gather any information about who created the model card in this repository although this information can be gathered from the Hugging Face Hub API.

### Annotations [optional]

There are no additional annotations in this dataset beyond the model card content.

#### Annotation process

N/A


#### Who are the annotators?

<!-- This section describes the people or systems who created the annotations. -->

N/A

#### Personal and Sensitive Information

<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->

We make no effort to anonymize the data. Whilst we don't expect the majority of model cards to contain personal or sensitive information, it is possible that some model cards may contain this information. Model cards may also link to websites or email addresses. 

## Bias, Risks, and Limitations

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

Model cards are created by the community and we do not have any control over the content of the model cards. We do not review the content of the model cards and we do not make any claims about the accuracy of the information in the model cards. 
Some model cards will themselves discuss bias and sometimes this is done by providing examples of bias in either the training data or the responses provided by the model. As a result this dataset may contain examples of bias. 

Whilst we do not directly download any images linked to in the model cards, some model cards may include images. Some of these images may not be suitable for all audiences.

### Recommendations

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

Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.

## Citation 

No formal citation is required for this dataset but if you use this dataset in your work, please include a link to this dataset page.

## Dataset Card Authors 

[@davanstrien](https://huggingface.co/davanstrien)

## Dataset Card Contact

[@davanstrien](https://huggingface.co/davanstrien)