Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions libraries/dagster-hf-datasets/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Changelog

## [Unreleased]

### Changed

- Fix broken links in usage.md, readme.md and image path for PyPI.

- Added resources in readme.md with additional examples and release post.

- Standardize project alias and add metadata to pyproject.toml
24 changes: 17 additions & 7 deletions libraries/dagster-hf-datasets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<p align="center">
<img
src="docs/assets/dagster_readme_logo.jpg"
src="https://raw.githubusercontent.com/dagster-io/community-integrations/main/libraries/dagster-hf-datasets/docs/assets/dagster_readme_logo.jpg"
alt="Dagster-HF-Datasets Logo"
width="500"
/>
Expand Down Expand Up @@ -32,7 +32,7 @@ pip install dagster-hf-datasets
## Development Install:

```bash
git clone https://github.com/dagster-io/dagster.git
git clone https://github.com/dagster-io/community-integrations.git

cd libraries/dagster-hf-datasets

Expand All @@ -47,7 +47,7 @@ pip install -e .

Get started with a simple example of materializing a Hugging Face dataset as a Dagster asset:

See [examples/basic_asset_pipeline.py](https://github.com/dagster/community-integrations/blob/main/libraries/dagster-hf-datasets/examples/basic_asset_pipeline.py)
See [examples/basic_asset_pipeline.py](https://github.com/dagster-io/community-integrations/blob/main/libraries/dagster-hf-datasets/examples/basic_asset_pipeline.py)

- Dataset materialization with `hf_dataset_asset`
- Parquet persistence via `HFParquetIOManager`
Expand All @@ -60,7 +60,7 @@ See [examples/basic_asset_pipeline.py](https://github.com/dagster/community-inte

Process large datasets efficiently with runtime-only streaming ingestion:

See [examples/multi_asset_pipeline.py](https://github.com/dagster/community-integrations/blob/main/libraries/dagster-hf-datasets/examples/multi_asset_pipeline.py)
See [examples/multi_asset_pipeline.py](https://github.com/dagster-io/community-integrations/blob/main/libraries/dagster-hf-datasets/examples/multi_asset_pipeline.py)

- Streaming dataset loading with `load_dataset(..., streaming=True)`
- Deterministic sampling of IterableDatasets
Expand All @@ -73,7 +73,7 @@ See [examples/multi_asset_pipeline.py](https://github.com/dagster/community-inte

Build production-grade data pipelines with dataset cleaning, transformation and publishing:

See [examples/multi_asset_pipeline.py](https://github.com/dagster/community-integrations/blob/main/libraries/dagster-hf-datasets/examples/dataset_pipeline.py)
See [examples/multi_asset_pipeline.py](https://github.com/dagster-io/community-integrations/blob/main/libraries/dagster-hf-datasets/examples/dataset_pipeline.py)

- Deduplication and filtering of raw data
- Text normalization and formatting
Expand All @@ -84,8 +84,18 @@ See [examples/multi_asset_pipeline.py](https://github.com/dagster/community-inte

## Documentation

- **[Usage Guide](https://github.com/dagster/community-integrations/blob/main/libraries/dagster-hf-datasets/docs/Usage.md)** — Quick start, configuration, publishing datasets to Hugging Face Hub, and metadata/lineage tracking
- **[API Reference](https://github.com/dagster/community-integrations/blob/main/libraries/dagster-hf-datasets/docs/API.md)** — Complete API documentation for `HuggingFaceResource`, asset decorators, and the IO manager
- [Usage Guide](https://github.com/dagster-io/community-integrations/blob/main/libraries/dagster-hf-datasets/docs/Usage.md) — Quick start, configuration, publishing datasets to Hugging Face Hub, and metadata/lineage tracking
- [API Reference](https://github.com/dagster-io/community-integrations/blob/main/libraries/dagster-hf-datasets/docs/API.md) — Complete API documentation for `HuggingFaceResource`, asset decorators, and the IO manager

---

## Resources

- [Release Article](https://huggingface.co/blog/AINovice2005/dagster-hf-datasets) — Deep dive into the motivation, architecture, runtime lifecycle and patterns behind `dagster-hf-datasets`.

- [Official Dagster Documentation](https://docs.dagster.io/integrations/libraries/hf-datasets) — Installation instructions, features and end-to-end usage guide.

- [Examples on Hugging Face](https://huggingface.co/buckets/the-hf-stack/dagster-hf-datasets-examples) — Explore 10+ curated example pipelines.

---

Expand Down
1 change: 0 additions & 1 deletion libraries/dagster-hf-datasets/docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ from dagster_hf_datasets import (
HuggingFaceResource,
hf_dataset_asset,
hf_multi_asset,
HFParquetIOManager, # Also available from dagster_hf_datasets.io_manager
)
```

Expand Down
2 changes: 1 addition & 1 deletion libraries/dagster-hf-datasets/docs/Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ publisher = HFDatasetPublisher(

## Examples

See [examples](libraries/dagster-hf-datasets/examples) for complete working pipelines and multi-asset patterns.
See [dagster-hf-datasets-examples](https://huggingface.co/buckets/the-hf-stack/dagster-hf-datasets-examples) for complete working pipelines and multi-asset patterns.

### Publishing a Dataset

Expand Down
40 changes: 39 additions & 1 deletion libraries/dagster-hf-datasets/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[project]
name = "dagster_hf_datasets"
name = "dagster-hf-datasets"
description = "Dagster Integration with HF Datasets"
readme = "README.md"
requires-python = ">=3.10"
Expand All @@ -10,6 +10,44 @@ dependencies = [
]
dynamic = ["version"]

authors = [
{ name = "Parag Ekbote" }
]

license = "Apache-2.0"

keywords = [
"dagster",
"huggingface",
"datasets",
"etl",
"data-pipelines",
"mlops"
]

classifiers = [
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"Intended Audience :: Science/Research",
"Intended Audience :: Information Technology",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Operating System :: OS Independent",
"Topic :: Database",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"Topic :: Software Development :: Libraries :: Python Modules",
"Topic :: Software Development :: Libraries",
"Topic :: Utilities",
]

[project.urls]
Documentation = "https://docs.dagster.io/integrations/libraries/hf-datasets"
GitHub = "https://github.com/dagster-io/community-integrations/tree/main/libraries/dagster-hf-datasets"
Examples = "https://huggingface.co/buckets/the-hf-stack/dagster-hf-datasets-examples"
"Release Article" = "https://huggingface.co/blog/AINovice2005/dagster-hf-datasets"

[dependency-groups]
dev = [
"ruff",
Expand Down
Loading