-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Add Documentation about dagster_hf_datasets
#33887
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
26f0faa
Update to add the initial doc page for hf datasets.
ParagEkbote 007afda
Merge branch 'dagster-io:master' into add-docs-hfdatasets
ParagEkbote 68535a9
update to add doc page and code snippets for hf datasets.
ParagEkbote 4819825
Merge branch 'add-docs-hfdatasets' of https://github.com/ParagEkbote/…
ParagEkbote bdfe8dd
Apply suggestions from code review (greptile)
ParagEkbote 9091e34
update the example.
ParagEkbote c55f5ee
improve the 2nd example more by making it explicit.
ParagEkbote 7ca1e9f
update the example to reduce ambiguity.
ParagEkbote 82a5faf
rm the first example to simplify things.
ParagEkbote c3d1f40
update wording of doc page.
ParagEkbote File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| title: Dagster & HF Datasets | ||
| sidebar_label: HF Datasets | ||
| sidebar_position: 1 | ||
| description: Use Dagster and Hugging Face Datasets to orchestrate data pipelines, materialize dataset assets, track metadata and lineage, and publish datasets to the Hub. | ||
| tags: [community-supported, datasets, metadata, streaming] | ||
| source: https://github.com/dagster-io/community-integrations/tree/main/libraries/dagster-hf-datasets | ||
| pypi: https://pypi.org/project/dagster_hf_datasets/ | ||
| sidebar_custom_props: | ||
| logo: images/integrations/hf_datasets.svg | ||
| community: true | ||
| partnerlink: https://github.com/huggingface/datasets | ||
| canonicalUrl: '/integrations/libraries/hf-datasets' | ||
| slug: '/integrations/libraries/hf-datasets' | ||
| --- | ||
|
|
||
| import CommunityIntegration from '@site/docs/partials/\_CommunityIntegration.md'; | ||
|
|
||
| <CommunityIntegration /> | ||
|
|
||
| <p>{frontMatter.description}</p> | ||
|
|
||
| The integration with HF Datasets makes it easy within Dagster to: | ||
|
|
||
| - Load a Hugging Face dataset as a Dagster asset with metadata. | ||
| - Stream large datasets efficiently in runtime-only mode | ||
| - Capture metadata and lineage for improved observability | ||
| - Build multi-asset pipelines that support dataset splits. | ||
| - Publish processed datasets back to the Hugging Face Hub. | ||
|
|
||
| ## Installation | ||
|
|
||
| <PackageInstallInstructions packageName="dagster-hf-datasets" /> | ||
|
|
||
| ## Example | ||
|
|
||
| These examples illustrate two usage examples: The first example is a basic asset pipeline for materializing an HF dataset with metadata and persistence. | ||
|
|
||
| <CodeExample path="docs_snippets/docs_snippets/integrations/basic_asset_example.py" language="python" /> | ||
|
|
||
| The second example is a fuller dataset pipeline for transformation, split-aware assets, and Hugging Face Hub publishing. | ||
|
|
||
| <CodeExample path="docs_snippets/docs_snippets/integrations/dataset_pipeline_example.py" language="python" /> | ||
|
|
||
| ## About HF Datasets | ||
|
|
||
| [HF Datasets](https://huggingface.co/docs/datasets/index) is a library for accessing, processing, and sharing AI datasets for Audio, Computer Vision, and Natural Language Processing (NLP) tasks. | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.