Skip to content

add docs for for SharedCycleIteratorState #8952

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

Merged
merged 2 commits into from
Aug 18, 2021
Merged

add docs for for SharedCycleIteratorState #8952

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c3d782
add docs
awaelchli Aug 17, 2021
0736ef5
Merge branch 'master' into docs/cycle-iterator
awaelchli Aug 18, 2021
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
8 changes: 7 additions & 1 deletion pytorch_lightning/trainer/supporters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,12 @@ def _agg_memory(self, how: str):

@dataclass
class SharedCycleIteratorState:
"""A state shared between all CylceIterators in a CombinedLoader.

With a shared state, the iterators can decide to terminate based on the state of all others.
If the mode is *max_size_cycle*, all iterators need to have finished before the combined loading is considered
finished, and otherwise any iterator finishing early will lead to all iterators ending early.
"""

mode: str = "max_size_cycle"
dataloaders: List[DataLoader] = field(default_factory=lambda: [])
Expand All @@ -126,7 +132,7 @@ def reset(self) -> None:
@property
def done(self) -> bool:
if not self.has_reset:
raise MisconfigurationException("Please, call reset once all dataloaders have been added.")
raise MisconfigurationException("Please call reset once all dataloaders have been added.")
if len(self.dataloaders) == 1:
return False
decision_fn = all if self.mode == "max_size_cycle" else any
Expand Down