Upload folder using huggingface_hub

README.md

@@ -1,147 +1,152 @@
----
-language:
-- en
-- ja
-license: cc-by-4.0
-tags:
-- not-for-all-audiences
-- anime
-- entertainment
-- japanese-culture
-- television
-pretty_name: Anime Titles Dataset
-size_categories:
-- n<1K
----
-
-# Anime Dataset
-
-## Dataset Description
-
-This dataset contains comprehensive information about anime series scraped from MyAnimeList (MAL). It includes detailed metadata about 871 (approx) anime series, making it valuable for various NLP tasks, recommendation systems, and cultural analysis.
-
-This dataset has NSFW content.
-
-### Dataset Summary
-
-- **Anime Entries**: 50 anime series with rich metadata
-- **Languages**: English and Japanese (titles, descriptions)
-- **Format**: JSONL (JSON Lines) for efficient streaming
-- **Source**: MyAnimeList (scraped data)
-
-## Dataset Structure
-
-### Data Files
-
-The dataset consists of one main file:
-
-- **anime_data.jsonl**: Contains information about anime series
-
-### Anime Data Fields
-
-Each anime entry contains:
-- `anime_id`: Unique identifier from MyAnimeList
-- `url`: MyAnimeList URL
-- `title_english`: English title
-- `title_romaji`: Romanized Japanese title
-- `title_japanese`: Original Japanese title
-- `title_synonyms`: Alternative titles
-- `synopsis`: Detailed plot summary
-- `description`: Additional description
-- `type`: Format (TV, Movie, OVA, etc.)
-- `episodes`: Number of episodes
-- `status`: Airing status
-- `aired_from` / `aired_to`: Air dates
-- `year`: Release year
-- `genres`: List of genres
-- `themes`: Thematic elements
-- `demographics`: Target demographic
-- `studios`: Production studios
-- `producers`: Production companies
-- `licensors`: Licensing companies
-- `source`: Source material
-- `duration`: Episode duration
-- `rating`: Age rating
-- `score`: User rating score
-- `characters`: List of character names
-- `related_anime`: Related series
-
-
-## Usage
-
-### Loading the Dataset
-
-```python
-import json
-
-# Load anime data
-anime_data = []
-with open('anime_data.jsonl', 'r', encoding='utf-8') as f:
-    for line in f:
-        anime_data.append(json.loads(line))
-```
-
-### Example: Analyzing Genres
-
-```python
-# Count anime by genre
-genre_counts = {}
-for anime in anime_data:
-    for genre in anime.get('genres', []):
-        genre_counts[genre] = genre_counts.get(genre, 0) + 1
-
-# Sort by popularity
-sorted_genres = sorted(genre_counts.items(), key=lambda x: x[1], reverse=True)
-```
-
-### Example: Finding Anime by Studio
-
-```python
-# Group anime by studio
-studio_anime = {}
-for anime in anime_data:
-    for studio in anime.get('studios', []):
-        if studio not in studio_anime:
-            studio_anime[studio] = []
-        studio_anime[studio].append(anime['title_english'] or anime['title_romaji'])
-```
-
-## Dataset Creation
-
-### Source Data
-
-The dataset was created by scraping data from MyAnimeList using Scrapy, focusing on the most popular anime series.
-
-### Data Collection Process
-
-1. Anime data was scraped from MyAnimeList's top anime pages (sorted by popularity)
-2. Data was cleaned and normalized for consistency
-3. All text was preserved in its original form (including Japanese characters)
-4. The scraper respects rate limits with a 2-second delay between requests
-
-### Preprocessing
-
-- Converted from JSON to JSONL format for better streaming support
-- Maintained UTF-8 encoding for proper Japanese character support
-- No text normalization applied to preserve original content
-
-## Considerations for Using the Data
-
-### Licensing
-
-This dataset is released under CC-BY-4.0 license. The data is collected from publicly available sources:
-- MyAnimeList content is used under fair use for research purposes
-- Users should respect the original content creators and MyAnimeList's terms of service
-
-### Limitations
-
-- Dataset size is limited to 50 anime entries
-- Data is biased towards popular anime (scraped from "top anime" pages)
-- Some fields may be empty or contain placeholder values
-- Data represents a snapshot from the collection date
-
-### Ethical Considerations
-
-- This dataset is intended for research and educational purposes
-- Users should be mindful of potential biases in user-generated content (ratings, favorites)
-- The dataset reflects the anime community's preferences and may not be representative of all anime content
+---
+language:
+- en
+- ja
+license: cc-by-4.0
+task_categories:
+- text-generation
+tags:
+- anime
+- characters
+- entertainment
+- japanese-culture
+- nsfw
+- notsafeforwork
+- Not-For-All-Audiences
+pretty_name: Anime Titles Dataset
+size_categories:
+- n<1K
+---
+
+# Anime Dataset
+
+## Dataset Description
+
+This dataset contains comprehensive information about anime series scraped from MyAnimeList (MAL). It includes detailed metadata about 871 (approx) anime series, making it valuable for various NLP tasks, recommendation systems, and cultural analysis.
+
+This dataset has NSFW content.
+
+### Dataset Summary
+
+- **Anime Entries**: 50 anime series with rich metadata
+- **Languages**: English and Japanese (titles, descriptions)
+- **Format**: JSONL (JSON Lines) for efficient streaming
+- **Source**: MyAnimeList (scraped data)
+
+## Dataset Structure
+
+### Data Files
+
+The dataset consists of one main file:
+
+- **anime_data.jsonl**: Contains information about anime series
+
+### Anime Data Fields
+
+Each anime entry contains:
+- `anime_id`: Unique identifier from MyAnimeList
+- `url`: MyAnimeList URL
+- `title_english`: English title
+- `title_romaji`: Romanized Japanese title
+- `title_japanese`: Original Japanese title
+- `title_synonyms`: Alternative titles
+- `synopsis`: Detailed plot summary
+- `description`: Additional description
+- `type`: Format (TV, Movie, OVA, etc.)
+- `episodes`: Number of episodes
+- `status`: Airing status
+- `aired_from` / `aired_to`: Air dates
+- `year`: Release year
+- `genres`: List of genres
+- `themes`: Thematic elements
+- `demographics`: Target demographic
+- `studios`: Production studios
+- `producers`: Production companies
+- `licensors`: Licensing companies
+- `source`: Source material
+- `duration`: Episode duration
+- `rating`: Age rating
+- `score`: User rating score
+- `characters`: List of character names
+- `related_anime`: Related series
+
+
+## Usage
+
+### Loading the Dataset
+
+```python
+import json
+
+# Load anime data
+anime_data = []
+with open('anime_data.jsonl', 'r', encoding='utf-8') as f:
+    for line in f:
+        anime_data.append(json.loads(line))
+```
+
+### Example: Analyzing Genres
+
+```python
+# Count anime by genre
+genre_counts = {}
+for anime in anime_data:
+    for genre in anime.get('genres', []):
+        genre_counts[genre] = genre_counts.get(genre, 0) + 1
+
+# Sort by popularity
+sorted_genres = sorted(genre_counts.items(), key=lambda x: x[1], reverse=True)
+```
+
+### Example: Finding Anime by Studio
+
+```python
+# Group anime by studio
+studio_anime = {}
+for anime in anime_data:
+    for studio in anime.get('studios', []):
+        if studio not in studio_anime:
+            studio_anime[studio] = []
+        studio_anime[studio].append(anime['title_english'] or anime['title_romaji'])
+```
+
+## Dataset Creation
+
+### Source Data
+
+The dataset was created by scraping data from MyAnimeList using Scrapy, focusing on the most popular anime series.
+
+### Data Collection Process
+
+1. Anime data was scraped from MyAnimeList's top anime pages (sorted by popularity)
+2. Data was cleaned and normalized for consistency
+3. All text was preserved in its original form (including Japanese characters)
+4. The scraper respects rate limits with a 2-second delay between requests
+
+### Preprocessing
+
+- Converted from JSON to JSONL format for better streaming support
+- Maintained UTF-8 encoding for proper Japanese character support
+- No text normalization applied to preserve original content
+
+## Considerations for Using the Data
+
+### Licensing
+
+This dataset is released under CC-BY-4.0 license. The data is collected from publicly available sources:
+- MyAnimeList content is used under fair use for research purposes
+- Users should respect the original content creators and MyAnimeList's terms of service
+
+### Limitations
+
+- Dataset size is limited to 50 anime entries
+- Data is biased towards popular anime (scraped from "top anime" pages)
+- Some fields may be empty or contain placeholder values
+- Data represents a snapshot from the collection date
+
+### Ethical Considerations
+
+- This dataset is intended for research and educational purposes
+- Users should be mindful of potential biases in user-generated content (ratings, favorites)
+- The dataset reflects the anime community's preferences and may not be representative of all anime content
+

UPLOAD_INSTRUCTIONS.md

@@ -0,0 +1,81 @@
+# How to Upload Your Anime Dataset to Hugging Face
+
+## Prerequisites
+
+1. **Hugging Face Account**: Create one at https://huggingface.co/join
+2. **Access Token**: Get it from https://huggingface.co/settings/tokens
+   - Click "New token"
+   - Give it a name (e.g., "anime-dataset-upload")
+   - Select "write" permission
+   - Copy the token (you'll need it later)
+
+## Upload Steps
+
+### Option 1: Using the Upload Script (Recommended)
+
+1. Open a terminal in the `anime_dataset/huggingface_dataset` directory
+2. Run the upload script:
+   ```bash
+   python upload_to_huggingface.py
+   ```
+3. Follow the prompts:
+   - Enter your Hugging Face username
+   - Enter a dataset name (or press Enter for default)
+   - Paste your access token (it will be hidden)
+4. Wait for the upload to complete
+
+### Option 2: Manual Upload via Web Interface
+
+1. Go to https://huggingface.co/new-dataset
+2. Enter a dataset name (e.g., "anime-dataset")
+3. Choose visibility (public/private)
+4. Create the dataset
+5. Use the "Files and versions" tab to upload:
+   - `README.md`
+   - `anime_data.jsonl`
+
+### Option 3: Using Git
+
+1. Create the dataset on Hugging Face first (see Option 2, steps 1-4)
+2. Clone the repository:
+   ```bash
+   git clone https://huggingface.co/datasets/YOUR_USERNAME/YOUR_DATASET_NAME
+   ```
+3. Copy your files to the cloned directory
+4. Commit and push:
+   ```bash
+   git add .
+   git commit -m "Add anime dataset"
+   git push
+   ```
+
+## Current Dataset Contents
+
+Your dataset directory contains:
+- `README.md` - Dataset documentation (dataset card)
+- `anime_data.jsonl` - 50 anime entries
+- `upload_to_huggingface.py` - Upload script (won't be uploaded)
+
+## After Upload
+
+1. Visit your dataset page: `https://huggingface.co/datasets/YOUR_USERNAME/YOUR_DATASET_NAME`
+2. Check that the dataset preview is working
+3. Verify the JSONL file is accessible
+4. Update the citation in README.md with the correct URL
+5. Add relevant tags for discoverability
+
+## Want More Anime Data?
+
+Check out `anime_dataset/SCRAPING_GUIDE.md` for instructions on how to scrape more anime entries. You can easily expand from 50 to 500+ anime!
+
+## Troubleshooting
+
+- **Authentication Error**: Make sure your token has write permissions
+- **Repository Exists**: The dataset name might be taken, try a different one
+- **Upload Fails**: Check your internet connection and file sizes
+- **Preview Not Working**: JSONL format should work automatically, but check for valid JSON on each line
+
+## Need Help?
+
+- Hugging Face Documentation: https://huggingface.co/docs/hub/datasets
+- Dataset Hub Guide: https://huggingface.co/docs/datasets/upload_dataset