Upload folder using huggingface_hub

README.md

@@ -1,34 +1,49 @@
-## UniRec datasets (file dump)
-
-This folder is structured for uploading to a Hugging Face **dataset repo** via `huggingface_hub.upload_folder(...)`.
-
-### Contents
-
-#### Amazon Beauty & Personal Care
+---
+dataset_name: UniRec-Amazon
+pretty_name: UniRec Amazon Sequential Recommendation Datasets
+tags:
+  - recommendation
+  - recsys
+  - amazon
+  - sequential-recommendation
+  - clickstream
+  - ranking
+language:
+  - en
+license: other  # Original data subject to Amazon / source terms
+task_categories:
+  - recommendation
+task_ids:
+  - next-item-prediction
+configs:
+  - config_name: amazon_beauty
+    data_files:
+      - amazon_beauty/**
+  - config_name: amazon_baby
+    data_files:
+      - amazon_baby/**
+notes:
+  - "Raw data derived from Amazon product and interaction datasets; redistributed here in processed form."
+  - "Yelp data is NOT included due to its license; users should obtain Yelp data separately and process it locally."
+---
+
+## UniRec datasets
+
+This dataset repo contains pre-processed Amazon recommendation data used in the UniRec project.
+
+### Amazon Beauty & Personal Care
 - `amazon_beauty/raw/`
-  - `Beauty_and_Personal_Care.jsonl(.gz)`: review/interaction records (raw JSON Lines).
-  - `meta_Beauty_and_Personal_Care.jsonl(.gz)`: item metadata (raw JSON Lines).
+  - `Beauty_and_Personal_Care.jsonl(.gz)`: raw review / interaction records (JSON Lines).
+  - `meta_Beauty_and_Personal_Care.jsonl(.gz)`: item metadata (JSON Lines).
 - `amazon_beauty/recbole/`
-  - `Amazon_Beauty_and_Personal_Care.inter`: RecBole-style interaction file (TSV).
+  - `Amazon_Beauty_and_Personal_Care.inter`: RecBole-style interaction file (TSV; user–item–rating–timestamp).
   - `Amazon_Beauty_and_Personal_Care.item`: RecBole-style item feature file (TSV).
 
-#### Amazon Baby Products
+### Amazon Baby Products
 - `amazon_baby/raw/`
-  - `Baby_Products.jsonl(.gz)`
-  - `meta_Baby_Products.jsonl(.gz)`
+  - `Baby_Products.jsonl(.gz)`: raw review / interaction records (JSON Lines).
+  - `meta_Baby_Products.jsonl(.gz)`: item metadata (JSON Lines).
 - `amazon_baby/recbole/`
-  - `Amazon_Baby_Products.inter`
-  - `Amazon_Baby_Products.item`
-
-### About Hugging Face “visualization”
-
-Hugging Face’s dataset viewer renders **tabular splits** best (Parquet/CSV/JSON arrays). Large `.jsonl` files and RecBole `.inter/.item` TSVs may not preview well.
-
-Recommended: add small, tabular **preview** files under `preview/`:
-- `preview/amazon_beauty_interactions.parquet`
-- `preview/amazon_beauty_items.parquet`
-- `preview/amazon_baby_interactions.parquet`
-- `preview/amazon_baby_items.parquet`
-
-These can be small samples (e.g., first 5k–50k rows) with clean columns. The full raw files can still live under `raw/` for reproducibility.
+  - `Amazon_Baby_Products.inter`: RecBole-style interaction file (TSV).
+  - `Amazon_Baby_Products.item`: RecBole-style item feature file (TSV).