outline card

README.md

@@ -45,55 +45,40 @@ tags:
 - ethics
 ---
 
-# Dataset Card for Dataset Name
+# Dataset Card for Hugging Face Hub Model Cards
 
-<!-- Provide a quick summary of the dataset. -->
+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 card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
+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
 
-<!-- Provide a longer summary of what this dataset is. -->
 
-
-
-- **Curated by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-
-### Dataset Sources [optional]
-
-<!-- Provide the basic links for the dataset. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **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
 
-<!-- Address questions around how the dataset is intended to be used. -->
+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
 
-### Direct Use
-
-<!-- This section describes suitable use cases for the dataset. -->
-
-[More Information Needed]
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
 
 [More Information Needed]
 
 ## Dataset Structure
 
-<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
-
-[More Information Needed]
+This dataset has a single split.
 
 ## Dataset Creation
 
@@ -101,51 +86,51 @@ This dataset card aims to be a base template for new datasets. It has been gener
 
 <!-- Motivation for the creation of this dataset. -->
 
-[More Information Needed]
+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
 
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+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. -->
 
-[More Information Needed]
+The data is downloaded using a CRON job on a daily basis. 
 
 #### Who are the source data producers?
 
-<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
-
-[More Information Needed]
+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]
 
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
+There are no additional annotations in this dataset beyond the model card content.
 
 #### Annotation process
 
-<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
+N/A
 
-[More Information Needed]
 
 #### Who are the annotators?
 
 <!-- This section describes the people or systems who created the annotations. -->
 
-[More Information Needed]
+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. -->
 
-[More Information Needed]
+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. -->
 
-[More Information Needed]
+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
 
@@ -153,32 +138,14 @@ This dataset card aims to be a base template for new datasets. It has been gener
 
 Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
 
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the dataset, 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 dataset or dataset card. -->
-
-[More Information Needed]
-
-## More Information [optional]
+## Citation 
 
-[More Information Needed]
+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 [optional]
+## Dataset Card Authors 
 
-[More Information Needed]
+[@davanstrien](https://huggingface.co/davanstrien)
 
 ## Dataset Card Contact
 
-[More Information Needed]
+[@davanstrien](https://huggingface.co/davanstrien)