Metadata-Version: 2.4
Name: pennyroyal-v253
Version: 0.1.0
Summary: Auto-downloader for the pennyroyal-v253 SGLang dataset on Kaggle
Author: mmfarabi
License: Apache-2.0
Project-URL: Homepage, https://huggingface.co/datasets/mmfarabi/pennyroyal-v253
Project-URL: Repository, https://huggingface.co/datasets/mmfarabi/pennyroyal-v253
Keywords: sglang,llm,llm-serving,inference,kaggle,dataset,huggingface,machine-learning,pennyroyal
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: huggingface_hub>=0.20.0
Dynamic: license-file


```markdown
# pennyroyal-v253

A lightweight helper package to automatically download and prepare the [`mmfarabi/pennyroyal-v253`](https://huggingface.co/datasets/mmfarabi/pennyroyal-v253) Hugging Face dataset directly into Kaggle environments.

---

## 📦 Installation

```bash
pip install pennyroyal-v253
```

---

## 🚀 Quick Start in Kaggle

### 1. Automatic Download on Import (Default)

Simply importing the package will verify and automatically fetch the dataset to `/kaggle/tmp/dataset/pennyroyal-v253`:

```python
import pennyroyal_v253

# The download path is also exposed as a constant
print(pennyroyal_v253.DATASET_PATH)
# Output: /kaggle/tmp/dataset/pennyroyal-v253
```

### 2. Custom Output Directory

If you want to download the dataset into a custom path or force a re-download:

```python
from pennyroyal_v253 import download_dataset

# Download to a custom directory
custom_path = download_dataset(output_dir="./my_dataset", force=False)
```

---

## ⚙️ Features

- **Fast Snapshot Downloads:** Powered by `huggingface_hub` for resumable, multi-threaded downloads.
- **Cache-Aware:** Skips downloading if the dataset already exists in the target directory (unless `force=True` is provided).
- **Kaggle Optimized:** Saves directly to `/kaggle/tmp/` to make use of Kaggle's fast local scratch storage without consuming disk space inside `/kaggle/working/`.

---

## 🔗 Dataset Information

- **Hugging Face Repository:** [mmfarabi/pennyroyal-v253](https://huggingface.co/datasets/mmfarabi/pennyroyal-v253)
- **Repository Type:** Dataset

---

## 📄 License

Distributed under the Apache 2.0 License.
