Upload readme

README.md

@@ -1,3 +1,189 @@
----
-license: mit
----
+---
+size_categories:
+- 100K<n<1M
+task_categories:
+- visual-question-answering
+dataset_info:
+  features:
+  - name: images
+    sequence:
+      image:
+        decode: false
+  - name: conversation_id
+    dtype: string
+  - name: model
+    dtype: string
+  - name: num_turns
+    dtype: int64
+  - name: conversation
+    list:
+      list:
+      - name: content
+        dtype: string
+      - name: role
+        dtype: string
+  - name: language
+    dtype: string
+  - name: user_id
+    dtype: int64
+  - name: tstamp
+    dtype: float64
+  - name: is_preset
+    dtype: bool
+  - name: preset_dataset
+    dtype: string
+  - name: categories
+    struct:
+    - name: captioning
+      dtype: bool
+    - name: code
+      dtype: bool
+    - name: creative_writing
+      dtype: bool
+    - name: diagram
+      dtype: bool
+    - name: entity_recognition
+      dtype: bool
+    - name: homework
+      dtype: bool
+    - name: humor
+      dtype: bool
+    - name: is_code
+      dtype: bool
+    - name: ocr
+      dtype: bool
+  splits:
+  - name: train
+    num_bytes: 85442332092
+    num_examples: 200000
+  download_size: 85131882032
+  dataset_size: 85442332092
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path: data/train-*
+---
+
+![Vision Arena Questions](vision_arena_questions_fig.png)
+
+# VisionArena-Battle: 30K Real-World Image Conversations with Pairwise Preference Votes
+
+200k single and multi-turn chats between users and VLM's collected on [Chatbot Arena](https://lmarena.ai/). 
+
+**WARNING:** Images may contain inappropriate content.
+
+![Vision Arena Direct Chat UI](direct_chat_ui.png)
+
+## Dataset Details
+
+* 200K conversations
+* 45 VLM's 
+* 138 languages
+* ~43k unique images
+* Question Category Tags (Captioning, OCR, Entity Recognition, Coding, Homework, Diagram, Humor, Creative Writing, Refusal)
+
+### Dataset Description
+
+200,000 conversations where users interact with two anonymized VLMs,collected through the open-source platform [Chatbot Arena](https://lmarena.ai/), where users chat with LLMs and VLMs through direct chat, side-by-side, or anonymous side-by-side chats. Users provide preference votes for responses, which are aggregated using the Bradley-Terry model to compute [leaderboard rankings](https://lmarena.ai/?leaderboard). Data for anonymous side-by-side chats can be found [here](https://huggingface.co/datasets/lmarena-ai/VisionArena-Battle).
+
+The dataset includes conversations from February 2024 to September 2024. Users explicitly agree to have their conversations shared before chatting. We apply an [NSFW](https://learn.microsoft.com/en-us/azure/ai-services/content-moderator/image-moderation-api), [CSAM](https://www.microsoft.com/en-us/photodna?oneroute=true), PII ([text](https://learn.microsoft.com/en-us/azure/search/cognitive-search-skill-pii-detection), and face detectors ([1](https://cloud.google.com/vision/docs/detecting-faces), [2](https://github.com/ageitgey/face_recognition)) to remove any inappropriate images, personally identifiable images/text, or images with human faces. These detectors are not perfect, so such images may still exist in the dataset.
+
+### Dataset Sources
+
+- **Repository:** https://github.com/lm-sys/FastChat
+- **Paper:** https://arxiv.org/abs/2412.08687
+- **Chat with the lastest VLMs and contribute your vote!** https://lmarena.ai/
+
+Images are stored in byte format, you can decode with `Image.open(BytesIO(img["bytes"]))`
+
+## 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. -->
+
+* **model** - model identity.
+* **images** - image (note: these are single image conversations only)
+* **conversation**- conversation with each model
+* **user_id** - hash of user id, based on IP address
+* **categories** - category labels (note: a question can belong to multiple categories)
+* **num_turns** - number of conversation turns
+* **tstamp** timestamp of when the conversation took place
+* **is_preset** - if the image is from the "random image button"
+* **dataset_preset** - which dataset the preset image is from. This can be either [NewYorker](https://huggingface.co/datasets/jmhessel/newyorker_caption_contest), [WikiArt](https://huggingface.co/datasets/huggan/wikiart), [TextVQA](https://huggingface.co/datasets/facebook/textvqa), [ChartQA](https://huggingface.co/datasets/lmms-lab/ChartQA), [DocQA](https://huggingface.co/datasets/lmms-lab/DocVQA), or [realworldqa](https://x.ai/blog/grok-1.5v)
+
+
+## Download Locally
+
+To download the dataset into a local directory, the code below will download the images into the VisionArena-Chat folder
+```
+from datasets import load_dataset
+from PIL import Image
+from io import BytesIO
+import json
+import os
+from tqdm import tqdm
+from multiprocessing import Pool, cpu_count
+
+def download_dataset(num_workers=None):
+    base_dir, images_dir = "VisionArena-Chat", os.path.join("VisionArena-Chat", "images")
+    os.makedirs(images_dir, exist_ok=True)
+    ds = load_dataset("lmarena-ai/VisionArena-Chat", split="train")
+    samples = list(ds)
+    num_workers = num_workers or min(cpu_count(), 8)
+    print(f"Processing samples using {num_workers} workers...")
+
+    def process_sample(idx_sample):
+        idx, sample = idx_sample
+        processed_images = []
+        for img_idx, img in enumerate(sample.get("images", [])):
+            img_filename = f"image_{idx}_{img_idx}.png"
+            img_path = os.path.join(images_dir, img_filename)
+            if not os.path.exists(img_path):
+                Image.open(BytesIO(img["bytes"])).save(img_path)
+            processed_images.append(os.path.join("images", img_filename))
+        sample["images"] = processed_images
+        return sample
+
+    with Pool(num_workers) as pool:
+        processed_data = list(tqdm(pool.imap(process_sample, enumerate(samples)), total=len(samples), desc="Processing samples"))
+    with open(os.path.join(base_dir, "data.json"), 'w', encoding='utf-8') as f:
+        json.dump(processed_data, f, ensure_ascii=False, indent=2)
+    print(f"Dataset downloaded and processed successfully!\nImages saved in: {images_dir}\nData saved in: {os.path.join(base_dir, 'data.json')}")
+
+if __name__ == "__main__":
+    download_dataset()
+```
+
+## Bias, Risks, and Limitations
+
+This dataset contains a large amount of STEM related questions, OCR tasks, and general problems like captioning. This dataset contains less questions which relate to specialized domains outside of stem. 
+
+**If you find your face or personal information in this dataset and wish to have it removed, or if you find hateful or inappropriate content,** please contact us at [email protected] or [email protected]. See licensing agreement below for more details.
+
+**BibTeX:**
+
+```
+@article{chou2024visionarena,
+      title={VisionArena: 230K Real World User-VLM Conversations with Preference Labels}, 
+      author={Christopher Chou and Lisa Dunlap and Koki Mashita and Krishna Mandal and Trevor Darrell and Ion Stoica and Joseph E. Gonzalez and Wei-Lin Chiang},
+      year={2024},
+      eprint={2412.08687},
+      archivePrefix={arXiv},
+      primaryClass={cs.LG},
+      url={https://arxiv.org/abs/2412.08687}, 
+}
+```
+
+## LMArena VisionArena dataset License Agreement
+This Agreement contains the terms and conditions that govern your access and use of the LMArena VisionArena dataset (as defined above). You may not use the LMArena VisionArena dataset if you do not accept this Agreement. By clicking to accept, accessing the LMArena VisionArena dataset, or both, you hereby agree to the terms of the Agreement. If you are agreeing to be bound by the Agreement on behalf of your employer or another entity, you represent and warrant that you have full legal authority to bind your employer or such entity to this Agreement. If you do not have the requisite authority, you may not accept the Agreement or access the LMArena VisionArena dataset on behalf of your employer or another entity.
+
+* Safety and Moderation: This dataset contains unsafe conversations that may be perceived as offensive or unsettling. User should apply appropriate filters and safety measures before utilizing this dataset for training dialogue agents.
+* Non-Endorsement: The views and opinions depicted in this dataset do not reflect the perspectives of the researchers or affiliated institutions engaged in the data collection process.
+* Legal Compliance: You are mandated to use it in adherence with all pertinent laws and regulations.
+* Model Specific Terms: When leveraging direct outputs of a specific model, users must adhere to its corresponding terms of use.
+* Non-Identification: You must not attempt to identify the identities of individuals or infer any sensitive personal data encompassed in this dataset.
+* Prohibited Transfers: You should not distribute, copy, disclose, assign, sublicense, embed, host, or otherwise transfer the dataset to any third party.
+* Right to Request Deletion: At any time, we may require you to delete all copies of the conversation dataset (in whole or in part) in your possession and control. You will promptly comply with any and all such requests. Upon our request, you shall provide us with written confirmation of your compliance with such requirement.
+* Termination: We may, at any time, for any reason or for no reason, terminate this Agreement, effective immediately upon notice to you. Upon termination, the license granted to you hereunder will immediately terminate, and you will immediately stop using the LMArena VisionArena dataset and destroy all copies of the LMArena VisionArena dataset and related materials in your possession or control.
+* Limitation of Liability: IN NO EVENT WILL WE BE LIABLE FOR ANY CONSEQUENTIAL, INCIDENTAL, EXEMPLARY, PUNITIVE, SPECIAL, OR INDIRECT DAMAGES (INCLUDING DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION, OR LOSS OF INFORMATION) ARISING OUT OF OR RELATING TO THIS AGREEMENT OR ITS SUBJECT MATTER, EVEN IF WE HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+* Subject to your compliance with the terms and conditions of this Agreement, we grant to you, a limited, non-exclusive, non-transferable, non-sublicensable license to use the LMArena VisionArena dataset, including the conversation data and annotations, to research, develop, and improve software, algorithms, machine learning models, techniques, and technologies for both research and commercial purposes.