Skip to content

[Doc] Fix on_train_batch_end description #4330

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 6 commits into from
Oct 26, 2020
Merged

[Doc] Fix on_train_batch_end description #4330

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
20c98d3
fix
amogkam Oct 24, 2020
79f0329
Merge branch 'master' into doc-fix
amogkam Oct 24, 2020
1e08937
more doc fixes
rohitgr7 Oct 24, 2020
9491a93
Merge branch 'master' into doc-fix
rohitgr7 Oct 24, 2020
f0d8feb
Merge branch 'master' into doc-fix
awaelchli Oct 25, 2020
5e05f77
Merge branch 'master' into doc-fix
tchaton Oct 26, 2020
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
10 changes: 5 additions & 5 deletions pytorch_lightning/core/hooks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ def on_train_batch_end(self, outputs: Any, batch: Any, batch_idx: int, dataloade
Called in the training loop after the batch.

Args:
outputs: The outputs of validation_step_end(validation_step(x))
outputs: The outputs of training_step_end(training_step(x))
batch: The batched data as it is returned by the training DataLoader.
batch_idx: the index of the batch
dataloader_idx: the index of the dataloader
Expand All @@ -156,7 +156,7 @@ def on_validation_batch_start(self, batch: Any, batch_idx: int, dataloader_idx:
Called in the validation loop before anything happens for that batch.

Args:
batch: The batched data as it is returned by the training DataLoader.
batch: The batched data as it is returned by the validation DataLoader.
batch_idx: the index of the batch
dataloader_idx: the index of the dataloader
"""
Expand All @@ -168,7 +168,7 @@ def on_validation_batch_end(self, outputs: Any, batch: Any, batch_idx: int, data

Args:
outputs: The outputs of validation_step_end(validation_step(x))
batch: The batched data as it is returned by the training DataLoader.
batch: The batched data as it is returned by the validation DataLoader.
batch_idx: the index of the batch
dataloader_idx: the index of the dataloader
"""
Expand All @@ -179,7 +179,7 @@ def on_test_batch_start(self, batch: Any, batch_idx: int, dataloader_idx: int) -
Called in the test loop before anything happens for that batch.

Args:
batch: The batched data as it is returned by the training DataLoader.
batch: The batched data as it is returned by the test DataLoader.
batch_idx: the index of the batch
dataloader_idx: the index of the dataloader
"""
Expand All @@ -191,7 +191,7 @@ def on_test_batch_end(self, outputs: Any, batch: Any, batch_idx: int, dataloader

Args:
outputs: The outputs of test_step_end(test_step(x))
batch: The batched data as it is returned by the training DataLoader.
batch: The batched data as it is returned by the test DataLoader.
batch_idx: the index of the batch
dataloader_idx: the index of the dataloader
"""
Expand Down