Skip to content

Commit d2a13a3

Browse files
committed
Document the training step helper used by the tests
Signed-off-by: uditmahato <uditmahato29271@gmail.com>
1 parent 939efd2 commit d2a13a3

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

tests/handlers/test_handler_mlflow.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,16 @@ def _update_metric(engine):
232232

233233
@staticmethod
234234
def _train_func(engine, batch):
235+
"""
236+
Produce the output of one training step, for an engine that does no real work.
237+
238+
Args:
239+
engine: the ignite engine running the step, unused.
240+
batch: the batch of the current step.
241+
242+
Returns:
243+
The batch shifted by one, as the single output of the step.
244+
"""
235245
return [batch + 1.0]
236246

237247
def test_system_metrics_disabled_by_default(self):

0 commit comments

Comments
 (0)