Update README.md

README.md

@@ -1,3 +1,80 @@
----
-license: cc-by-4.0
----
+---
+license: cc-by-nc-3.0
+language:
+- en
+pretty_name: Stark
+tags:
+- multi-modal dialogue
+annotation_creators:
+- machine-generated
+task_ids:
+- conversational
+dataset_size: 899K
+---
+
+# Dataset Card for Stark
+
+[🏠 Homepage](https://stark-dataset.github.io/) | [💻 Github](https://github.com/passing2961/Stark) | [📄 Arxiv](https://arxiv.org/abs/2407.03958) | [📕 PDF](https://arxiv.org/pdf/2407.03958)
+
+## List of Provided Model Series
+- **Ultron-Summarizer-Series:** [🤖 Ultron-Summarizer-1B](https://huggingface.co/passing2961/Ultron-Summarizer-1B) | [🤖 Ultron-Summarizer-3B](https://huggingface.co/passing2961/Ultron-Summarizer-3B) | [🤖 Ultron-Summarizer-8B](https://huggingface.co/passing2961/Ultron-Summarizer-8B)
+- **Ultron 7B**: [🤖 Ultron-7B](https://huggingface.co/passing2961/Ultron-7B)
+
+> 🚨 Disclaimer: All models and datasets are intended for research purposes only.
+
+## Dataset Description
+- **Repository:** [Code](https://github.com/passing2961/Stark)
+- **Paper:** [Stark: Social Long-Term Multi-Modal Conversation with Persona Commonsense Knowledge](https://arxiv.org/abs/2407.03958)
+- **Point of Contact:** [Young-Jun Lee](mailto:[email protected])
+
+## Dataset Summary
+
+**Stark** is a publicly available, large-scale, long-term multi-modal conversation dataset that encompasses a diverse range of social personas, multi-modality formats, time intervals, and images. To automatically construct Stark, we introduce a novel multi-modal contextualization framework, **MCU**, which generates long-term multi-modal dialogues distilled from ChatGPT and our proposed **Plan-and-Execute Image Aligner**. An overview of MCU and an example from Stark are illustrated below.
+
+![MCU Pipeline](stark_mcu_overview.PNG)
+
+**Note**: The **Stark** dataset contains many images that originate from different sources, including a personalized text-to-image generator (i.e., [PhotoMaker](https://photo-maker.github.io/)), [Bing Search](https://pypi.org/project/icrawler/), and Image DB retrieval, thanks to our proposed **Plan-and-Execute Image Aligner** to ensure the high quality of the Stark dataset. Therefore, we divide the entire collection of images into two repositories based on the source:
+
+1. **This Repository**: Contains images sourced from [CC12M](https://github.com/google-research-datasets/conceptual-12m) and [RedCaps12M](https://redcaps.xyz/), which provide the image URL links.
+2. **Another Repository**: Contains images from the personalized text-to-image generator, Bing Search, and Image DB retrieval (excluding CC12M and RedCaps12M). This dataset is provided in [this repository](https://huggingface.co/datasets/passing2961/stark-image).
+
+> ⚠️ **Warning**: Since the images provided in this repository are sourced from CC12M and RedCaps12M, some images may not be accessible if the original URL owners have restricted access or removed them.
+
+For image database retrieval, we use CLIP (i.e., `ViT-L/14@336px`) to retrieve images from the prepared source image datasets: [CC12M](https://github.com/google-research-datasets/conceptual-12m), [RedCaps12M](https://redcaps.xyz/), [ChartQA](https://github.com/vis-nlp/ChartQA), [AI2D](https://arxiv.org/pdf/1603.07396v1), and [MathVision](https://huggingface.co/datasets/MathLLMs/MathVision). For efficient searching, we utilize [AutoFaiss](https://github.com/criteo/autofaiss).
+
+## Dataset Structure
+
+Since the number of images is large (roughly 899K), we store and provide the image datasets in WebDataset format for efficiency.
+
+| Field   | Type   | Description  |
+|---------|--------|--------------|
+| `key`   | str    | A unique identifier for each data entry in the dataset. |
+| `url`   | str    | The URL path to the image stored in the dataset repository on HuggingFace. All URLs point to the base HuggingFace repository where images are stored. |
+| `json`  | dict   | Contains additional metadata and information for each image, structured as a dictionary. The JSON field typically includes the following keys: `image_source`, `image_url`, `index`. |
+
+- **`image_source`**: Source of the image (`cc12m`, `redcaps12m`), where:
+  - `"cc12m"`: Image from [CC12M](https://github.com/google-research-datasets/conceptual-12m) via Image DB retrieval.
+  - `"redcaps12m"`: Image from the [RedCaps12M](https://redcaps.xyz/) dataset via Image DB retrieval.
+- **`image_url`**: External URL where the image was originally sourced.
+- **`index`**: A unique index identifier for each image within the dataset, which is the same as the `key` field.
+
+## Languages
+
+- English
+
+## Further Details and Limitations
+
+For additional information and limitations, please refer to our [paper](https://arxiv.org/abs/2407.03958).
+
+## License and Recommendations
+
+The **Stark** dataset is intended for research purposes only. Despite our efforts to generate high-quality and diverse personalized images, users should be mindful of ethical considerations when utilizing the dataset.
+
+## Acknowledgements
+
+This work was supported by a grant from the KAIST-KT joint research project through AI Tech Lab, Institute of Convergence Technology, funded by KT [Project No. G01230605, Development of Task-oriented Persona-based Dialogue Generation Combining Multi-modal Interaction and Knowledge Modeling].
+
+## Citation
+
+If you find the resources in this repository useful, please cite our work:
+