Upload metadata.parquet

LICENSE

@@ -0,0 +1,26 @@
+MIT License-Minimal-Modified
+====================================
+Copyright (c) 2024 **NoCopyright**
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this dataset and associated documentation files (the "Dataset"), subject to the following conditions:
+
+1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Dataset.
+
+2. Users must possess sufficient knowledge and expertise to use the Dataset appropriately. Any derived works or outputs are the sole responsibility of the user.
+
+3. PROHIBITED USES:
+   - Using the Dataset or its outputs for harassment, threats, or intimidation
+   - Spreading false or misleading information
+   - Any use intended to cause harm to individuals, organizations, or society
+   - Generating content that violates applicable laws or regulations
+   - Modifying content for controversial materials against ethical guidelines
+   - Any use that incites hate, violence, or discrimination
+
+4. Users explicitly agree to:
+   - Adhere to all conditions specified in this LICENSE
+   - Take full responsibility for Dataset usage and resulting consequences
+   - Comply with the opt-out policy of the original booru database
+
+5. THE DATASET IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE DATASET OR THE USE OR OTHER DEALINGS IN THE DATASET.
+
+6. Users agree to indemnify and hold harmless the creators against any claims, damages, or liabilities arising from their use of the Dataset.

README.md

@@ -18,8 +18,145 @@ annotations_creators:
 source_datasets:
 - danbooru
 ---
+# 🎨 Danbooru2024 Dataset
 
-# Danbooru2024 Dataset
+![Dataset Size](https://img.shields.io/badge/Images-6.5M-blue)
+![Language](https://img.shields.io/badge/Languages-EN%20|%20JA-green)
+![Category](https://img.shields.io/badge/Category-Image%20Classification-orange)
 
-6457843 original images in total.
+## 📊 Dataset Overview
 
+The **Danbooru2024** dataset is a comprehensive collection focused on animation and illustration artwork, derived from the official Danbooru platform. It contains approximately **6.5 million high-quality, user-annotated images** with corresponding tags and textual descriptions.
+
+This dataset is filtered from an original set of **8.3 million entries**, excluding NSFW-rated, **opt-out** entries to create a more accessible and audience-friendly resource. It addresses the challenges associated with overly crawled booru databases by providing a curated and well-structured solution.
+
+## ✨ Features
+
+### 📋 Metadata Support
+Includes a Parquet format metadata.
+
+Example code for usage:
+```python
+# install necessary packages, you can choose pyarrow or fastparquet
+#%pip install pandas pyarrow
+
+from tqdm.auto import tqdm
+import pandas as pd
+tqdm.pandas() # register progress_apply
+
+# read parquet file
+df = pd.read_parquet('metadata.parquet')
+print(df.head()) # check the first 5 rows
+
+#print(df.columns) # you can check the columns of the dataframe
+necessary_rows = [
+    "created_at", "score", "rating", "tag_string", "up_score", 
+    "down_score", "fav_count"
+]
+df = df[necessary_rows] # shrink the dataframe to only necessary columns
+df['created_at'] = pd.to_datetime(df['created_at']) # convert to datetime
+
+datetime_start = pd.Timestamp('2007-01-01', tz='UTC')
+datetime_end = pd.Timestamp('2008-01-01', tz='UTC')
+subdf = df[(df['created_at'] >= datetime_start) & 
+           (df['created_at'] < datetime_end)]
+
+# count some rating
+print(subdf['rating'].value_counts())
+# export subdataframe
+subdf.to_parquet('metadata-2007.parquet')
+```
+
+### 📥 Partial Downloads
+To simplify downloading specific entries, use the **[CheeseChaser](https://github.com/deepghs/cheesechaser)** library:
+
+```python
+#%pip install cheesechaser # >=0.2.0
+from cheesechaser.datapool import Danbooru2024SfwDataPool
+from cheesechaser.query import DanbooruIdQuery
+
+pool = Danbooru2024SfwDataPool()
+#my_waifu_ids = DanbooruIdQuery(['surtr_(arknights)', 'solo']) 
+# above is only available when Danbooru is accessible, if not, use following:
+import pandas as pd
+
+# read parquet file
+df = pd.read_parquet('metadata.parquet', 
+                     columns=['id', 'tag_string']) # read only necessary columns
+                     
+#surtr_(arknights) -> gets interpreted as regex so we need to escape the brackets
+subdf = df[df['tag_string'].str.contains('surtr_\\(arknights\\)') & 
+           df['tag_string'].str.contains('solo')]
+ids = subdf.index.tolist()
+print(ids[:5]) # check the first 5 ids
+
+# download danbooru images with surtr+solo, to directory /data/exp2_surtr
+pool.batch_download_to_directory(
+    resource_ids=ids,
+    dst_dir='/data/exp2_surtr',
+    max_workers=12,
+)
+```
+# Terms and Conditions for Dataset Use
+
+## General Use Requirements
+- **User Responsibility**:  
+  Users must possess sufficient knowledge and expertise to use the dataset appropriately. Any derived works or outputs created using the dataset are the sole responsibility of the user. The creators of the dataset do not offer any guarantees or warranties regarding the outcomes or uses of such derived works.
+
+## License Agreement
+- **Mandatory Agreement**:  
+  Usage of this dataset is contingent upon the user’s acceptance of the associated LICENSE terms. Without agreement, users are prohibited from utilizing the dataset.
+
+- **Modifications and Updates**:  
+  The dataset may be subject to updates or changes over time. These modifications are governed by the same LICENSE terms and conditions.
+
+- **Opt-Out Compliance**:  
+  The dataset aligns with the opt-out policy of the original booru database. If applicable, any modifications to this policy will be reflected and respected in the dataset.
+
+## Prohibited Uses
+The dataset explicitly prohibits the following activities:
+
+1. **Harmful or Malicious Activities**:  
+   - Using the dataset or its outputs to harass, threaten, or intimidate individuals or groups.  
+   - Spreading false or misleading information.  
+   - Any use intended to cause harm to individuals, organizations, or society.
+
+2. **Illegal Activities**:  
+   - Generating content or outputs that violate local, national, or international laws.  
+   - Any use that breaches applicable regulations or promotes unlawful actions.
+
+3. **Unethical or Offensive Content Modification**:  
+   - Modified for producing controversial materials that go against ethical guidelines or community standards.  
+   - Any use that could incite hate, violence, or discrimination.
+  
+## User Agreement and Acknowledgment
+By using this dataset, users explicitly agree to:
+- Adhere to the conditions specified in the LICENSE.
+- Take full responsibility for how the dataset and its outputs are utilized, including any consequences resulting from their use.
+
+## Disclaimer
+- **No Warranties**:  
+  The creators of the dataset provide it "as is" and make no warranties regarding the dataset's quality, reliability, or fitness for any particular purpose.
+
+- **Indemnification**:  
+  Users agree to indemnify and hold harmless the creators against any claims, damages, or liabilities arising from their use of the dataset.
+
+## 🏷️ Dataset Information
+
+- **License**: Other
+- **Task Categories**:
+  - Image Classification
+  - Zero-shot Image Classification
+  - Text-to-Image
+- **Languages**:
+  - English
+  - Japanese
+- **Tags**:
+  - Art
+  - Anime
+- **Size Category**: 1M < n < 10M
+- **Annotation Creators**: No annotation
+- **Source Datasets**: [Danbooru](danbooru.donmai.us)
+
+---
+*Note: This dataset is provided for research and development purposes. Please ensure compliance with all applicable usage terms and conditions.*

metadata.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8cc44aee3237b4c51e44da499208ec0214650cce7e34ab669dbcbc006fad151b
+size 5520278642