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

added from_generator method to IterableDataset class. #5052

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 9 additions & 4 deletions src/datasets/io/generator.py
Expand Up @@ -24,7 +24,7 @@ def __init__(
**kwargs,
)

def read(self):
def read(self, streaming: bool = False):
mariosasko marked this conversation as resolved.
Show resolved Hide resolved
download_config = None
download_mode = None
ignore_verifications = False
Expand All @@ -40,8 +40,13 @@ def read(self):
use_auth_token=use_auth_token,
)

# Build iterable dataset
if streaming:
dataset = self.builder.as_streaming_dataset(split="train")

# Build dataset for splits
dataset = self.builder.as_dataset(
split="train", ignore_verifications=ignore_verifications, in_memory=self.keep_in_memory
)
else:
dataset = self.builder.as_dataset(
split="train", ignore_verifications=ignore_verifications, in_memory=self.keep_in_memory
)
return dataset
40 changes: 40 additions & 0 deletions src/datasets/iterable_dataset.py
Expand Up @@ -1339,6 +1339,46 @@ def _resolve_features(self):
token_per_repo_id=self._token_per_repo_id,
)

@staticmethod
def from_generator(
generator: Callable,
features: Optional[Features] = None,
cache_dir: str = None,
keep_in_memory: bool = False,
gen_kwargs: Optional[dict] = None,
):
"""Create an Iterable Dataset from a generator.

Args:
generator (:obj:`Callable`): A generator function that `yields` examples.
features (:class:`Features`, optional): Dataset features.
cache_dir (:obj:`str`, optional, default ``"~/.cache/huggingface/datasets"``): Directory to cache data.
keep_in_memory (:obj:`bool`, default ``False``): Whether to copy the data in-memory.
gen_kwargs(:obj:`dict`, optional): Keyword arguments to be passed to the `generator` callable.

Returns:
:class:`IterableDataset`

Example:

```py
>>> def gen():
... yield {"text": "Good", "label": 0}
... yield {"text": "Bad", "label": 1}
...
>>> ds = IterableDataset.from_generator(gen)
```
"""
from .io.generator import GeneratorDatasetInputStream

return GeneratorDatasetInputStream(
generator=generator,
features=features,
cache_dir=cache_dir,
keep_in_memory=keep_in_memory,
gen_kwargs=gen_kwargs,
).read(streaming=True)


def iterable_dataset(
ex_iterable: Iterable,
Expand Down