Create README.md

README.md

@@ -0,0 +1,149 @@
+---
+license: cc-by-4.0
+task_categories:
+- image-to-text
+- text-generation
+language:
+- en
+tags:
+- multimodal
+pretty_name: MINT-1T
+size_categories:
+- 100B<n<1T
+---
+
+<h1 align="center">
+  🍃 MINT-1T:<br>Scaling Open-Source Multimodal Data by 10x:<br> A Multimodal Dataset with One Trillion Tokens
+</h1>
+
+🍃 MINT-1T is an open-source **M**ultimodal **INT**erleaved dataset with 1 trillion text tokens and 3.4 billion images, a 10x scale-up from existing open-source datasets. Additionally, we include previously untapped sources such as PDFs and ArXiv papers. 🍃 MINT-1T is designed to facilitate research in multimodal pretraining. 🍃 MINT-1T is created by a team from the University of Washington in collaboration with Salesforce Research, other academic institutions including Stanford University, University of Texas at Austin, and University of California Berkeley.
+
+You are currently viewing a subset of the PDF portion of 🍃 MINT-1T associated with CommonCrawl dump `CC-2024-18`. For other PDF, HTML, and ArXiv subsets, refer to the [🍃 MINT-1T collection](https://huggingface.co/collections/mlfoundations/mint-1t-6690216ca4d0df7e518dde1c).
+
+## Dataset Details
+
+### Dataset Sources
+
+- **Repository**: https://github.com/mlfoundations/MINT-1T
+- **Paper:** https://arxiv.org/abs/2406.11271
+- **Blog:** 
+
+## Uses
+
+### Direct Use
+
+<!-- This section describes suitable use cases for the dataset. -->
+
+🍃 MINT-1T is designed to facilitate research in multimodal pretraining. The dataset can be used for training multimodal models that can reson about interleaved text and images sequences such as [Idefics2](https://huggingface.co/HuggingFaceM4/idefics2-8b), [XGen-MM](https://huggingface.co/Salesforce/xgen-mm-phi3-mini-instruct-r-v1), and [Chameleon](https://huggingface.co/facebook/chameleon-30b).
+
+### Out-of-Scope Use
+
+<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+
+🍃 MINT-1T was built to make research into large multimodal models more accessible. Using
+the dataset to train models that ingest or generate personally identifying information (such
+as images of people’s faces and other sensitive content) as well as military applications are all inappropriate use cases of 🍃 MINT-1T.
+
+## Dataset Creation
+
+### Curation Rationale
+
+🍃 MINT-1T was created to address a significant gap in the open-source domain by providing a large-scale multimodal interleaved dataset for pre-training large multimodal models. This dataset aims to be a valuable resource for the research community, facilitating open science in multimodal pretraining.
+
+### Source Data
+
+The dataset is a comprehensive collection of multimodal documents from various sources:
+
+- HTML documents: Filtered from CommonCrawl WARC dumps spanning from 2017 to 2024
+- PDF documents: Extracted from CommonCrawl WAT dumps covering 2023 to 2024
+- ArXiv documents: A subset of papers from the ArXiv repository
+
+In total, 🍃 MINT-1T contains 1056.8 million documents, broken down as follows:
+- 1029.4 million HTML documents
+- 26.8 million PDF documents
+- 0.6 million ArXiv documents
+
+#### Data Collection and Processing
+
+The data collection and processing involved several steps:
+
+1. Document Extraction:
+   - HTML documents were parsed from CommonCrawl WARC files
+   - PDF documents were extracted from CommonCrawl WAT files
+   - ArXiv papers were directly sourced from ArXiv S3 buckets
+
+2. Filtering Process:
+   - Applied text quality filters to ensure content relevance and readability
+   - Removed duplicate content at both paragraph and document levels
+   - Filtered out undesirable content based on predefined criteria
+   - Verified image availability and quality for HTML documents
+   - Limited PDF size to 50MB and 50 pages to manage dataset size and quality
+
+3. Image Processing:
+   - Used NSFW image detection to remove pornographic or otherwise undesirable images
+   - Removed images smaller than 150 pixels or larger than 20,000 pixels
+   - Adjusted aspect ratio thresholds for HTML (2:1) and PDF (3:1) to preserve scientific figures
+
+4. Text Processing:
+   - Used fasttext for language identification, focusing on English content
+   - Masked personally identifiable information such as email addresses and IP addresses
+   - Applied paragraph and document-level deduplication using Bloom filters
+
+5. PDF Specific Processing:
+   - Used PyMuPDF for parsing PDFs and extracting reading order
+   - Clustered text blocks based on columns and ordered from top left to bottom right
+
+6. ArXiv Specific Processing:
+   - Used TexSoup to parse LaTeX source code and interleave images with text
+   - Cleaned up LaTeX code by removing imports, bibliography, tables, and citation tags
+
+Various open-source tools were utilized in this process, including fasttext, [PyMuPDF](https://github.com/pymupdf/PyMuPDF), and [DCLM](https://www.datacomp.ai/dclm/) and [bff](https://github.com/revbucket/bff) for deduplication and content filtering.
+
+#### Personal and Sensitive Information
+
+Despite sourcing from public web data, significant efforts were made to minimize the inclusion of personal and sensitive information:
+
+- Email addresses and IP addresses were masked to protect privacy
+- An NSFW image classifierto remove inappropriate visual content
+- URLs containing substrings associated with undesirable or sensitive content were filtered out
+
+However, users should be aware that as the data originates from the public web, it may still contain some sensitive or personal information. The dataset creators acknowledge this limitation and advise users to exercise caution and potentially apply additional filtering based on their specific use cases.
+
+## Bias, Risks, and Limitations
+
+Several potential biases, risks, and limitations have been identified:
+
+1. Data Bias: As the dataset is sourced from web crawls, it may inherit biases present in online content. This could include demographic, cultural, or topical biases.
+
+2. Content Risks: Despite extensive filtering, there's a possibility that some offensive, insensitive, or inappropriate content may remain in the dataset.
+
+3. Image Availability: The dataset relies on external image URLs, which may become unavailable over time due to link rot, potentially affecting the dataset's long-term usability.
+
+4. PDF Parsing Limitations: The current method for extracting reading order from PDFs may not always accurately capture the intended flow, especially for documents with complex layouts.
+
+5. Potential Legal and Ethical Concerns: While efforts were made to respect robots.txt files and remove sensitive information, there may still be content that individuals did not explicitly consent to include.
+
+### Recommendations
+
+Given these considerations, the following recommendations are provided:
+
+1. Additional Filtering: Users are strongly encouraged to apply additional filtering based on their specific use case and ethical considerations.
+
+2. Inappropriate Use Cases: The dataset is not recommended for applications involving the processing or generation of personally identifying information, nor for military applications.
+
+3. Legal Compliance: Users should independently verify compliance with applicable laws before employing MINT-1T for commercial purposes.
+
+4. Bias Awareness: Researchers and developers should be cognizant of potential biases in the dataset and consider their impact on model training and outputs.
+
+## License
+We release 🍃 MINT-1T under a CC-BY-4.0 license, designating it primarily as a research artifact. While the dataset is freely available, users are responsible for ensuring its legal use in commercial settings. Users must independently verify compliance with applicable laws before employing MINT-1T for commercial purposes.
+
+## Citation
+
+```
+@article{awadalla2024mint1t,
+      title={MINT-1T: Scaling Open-Source Multimodal Data by 10x: A Multimodal Dataset with One Trillion Tokens}, 
+      author={Anas Awadalla and Le Xue and Oscar Lo and Manli Shu and Hannah Lee and Etash Kumar Guha and Matt Jordan and Sheng Shen and Mohamed Awadalla and Silvio Savarese and Caiming Xiong and Ran Xu and Yejin Choi and Ludwig Schmidt},
+      year={2024}
+}
+```