Skip to content
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

Update FAQs to indicate wrapping not supported #822

Merged
merged 4 commits into from
Nov 4, 2024
Merged
Changes from 1 commit
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
2 changes: 2 additions & 0 deletions docs/source/getting_started/faqs_and_tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ The `epoch_size` attribute of StreamingDataset is the number of samples per epoc
### What's the difference between `StreamingDataset` vs. datasets vs. streams?
`StreamingDataset` is the dataset class. It can take in multiple streams, which are just data sources. It combines these streams into a single dataset. `StreamingDataset` does not *stream* data, as continuous bytes; instead, it downloads shard files to enable a continuous flow of samples into the training job. `StreamingDataset` is an `IterableDataset` as opposed to a map-style dataset -- samples are retrieved as needed.

### I wrapped my streaming dataloader with HuggingFace's `accelerate` dataloader wrapper and my run is hanging, what should I do?
snarayan21 marked this conversation as resolved.
Show resolved Hide resolved
When using HF `accelerate` with `streaming` for training, do not wrap the dataloader as this will cause the run to fail.
snarayan21 marked this conversation as resolved.
Show resolved Hide resolved

## 🤓 Helpful Tips

Expand Down
Loading