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.

Sign up for GitHub

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

Jump to bottom

Adds a note mentioning that DatasetIterator is not thread-safe. #630

Merged
merged 1 commit into from
Nov 22, 2024
+5 −1
Merged

Adds a note mentioning that DatasetIterator is not thread-safe. #630

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion grain/_src/python/dataset/dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1037,7 +1037,11 @@ def __iter__(self) -> DatasetIterator[T]:


class DatasetIterator(Iterator[T], abc.ABC):
"""`IterDataset` iterator."""
"""`IterDataset` iterator.

NOTE: The methods are assumed to be thread-unsafe. Please ensure only a single
thread can access a `DatasetIterator` instance.
"""

# Whether this transformation mutates parent elements. This does not affect
# the transformation itself, only used for information purposes in statistics.
Expand Down
Loading