From 20d6c9c0f303384ff6ebceb6eae6f04494b09bb8 Mon Sep 17 00:00:00 2001
From: ydcjeff <ydcjeff@outlook.com>
Date: Sun, 21 Feb 2021 18:52:21 +0630
Subject: [PATCH 1/2] chore(docs): add examples in supervised_training_steps

---
 ignite/engine/__init__.py | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/ignite/engine/__init__.py b/ignite/engine/__init__.py
index 0eb0b15821b2..ec61cdff367d 100644
--- a/ignite/engine/__init__.py
+++ b/ignite/engine/__init__.py
@@ -69,6 +69,15 @@ def supervised_training_step(
     Returns:
         Callable: update function.
 
+    Example::
+
+        model = ...
+        optimizer = ...
+        loss_fn = ...
+
+        update_fn = supervised_training_step(model, optimizer, loss_fn, 'cuda')
+        trainer = Engine(update_fn)
+
     .. versionadded:: 0.5.0
     """
 
@@ -115,6 +124,16 @@ def supervised_training_step_amp(
     Returns:
         Callable: update function
 
+    Example::
+
+        model = ...
+        optimizer = ...
+        loss_fn = ...
+        scaler = torch.cuda.amp.GradScaler(2**10)
+
+        update_fn = supervised_training_step_amp(model, optimizer, loss_fn, 'cuda', scaler=scaler)
+        trainer = Engine(update_fn)
+
     .. versionadded:: 0.5.0
     """
 
@@ -170,6 +189,15 @@ def supervised_training_step_apex(
     Returns:
         Callable: update function.
 
+    Example::
+
+        model = ...
+        optimizer = ...
+        loss_fn = ...
+
+        update_fn = supervised_training_step_apex(model, optimizer, loss_fn, 'cuda')
+        trainer = Engine(update_fn)
+
     .. versionadded:: 0.5.0
     """
 
@@ -220,6 +248,15 @@ def supervised_training_step_tpu(
     Returns:
         Callable: update function.
 
+    Example::
+
+        model = ...
+        optimizer = ...
+        loss_fn = ...
+
+        update_fn = supervised_training_step_tpu(model, optimizer, loss_fn, 'xla')
+        trainer = Engine(update_fn)
+
     .. versionadded:: 0.5.0
     """
     try:

From 8ad516d07c05fa70d33acf93daeca4bac4181d96 Mon Sep 17 00:00:00 2001
From: ydcjeff <ydcjeff@outlook.com>
Date: Mon, 22 Feb 2021 15:20:45 +0630
Subject: [PATCH 2/2] fix: add import from

---
 ignite/engine/__init__.py | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/ignite/engine/__init__.py b/ignite/engine/__init__.py
index ec61cdff367d..ba8aae0465d1 100644
--- a/ignite/engine/__init__.py
+++ b/ignite/engine/__init__.py
@@ -71,6 +71,8 @@ def supervised_training_step(
 
     Example::
 
+        from ignite.engine import Engine, supervised_training_step
+
         model = ...
         optimizer = ...
         loss_fn = ...
@@ -126,6 +128,8 @@ def supervised_training_step_amp(
 
     Example::
 
+        from ignite.engine import Engine, supervised_training_step_amp
+
         model = ...
         optimizer = ...
         loss_fn = ...
@@ -191,6 +195,8 @@ def supervised_training_step_apex(
 
     Example::
 
+        from ignite.engine import Engine, supervised_training_step_apex
+
         model = ...
         optimizer = ...
         loss_fn = ...
@@ -250,6 +256,8 @@ def supervised_training_step_tpu(
 
     Example::
 
+        from ignite.engine import Engine, supervised_training_step_tpu
+
         model = ...
         optimizer = ...
         loss_fn = ...