add desc for minimize (#3216)

Lightning-AI · Aug 27, 2020 · 40eaa21 · 40eaa21
1 parent f03943e
commit 40eaa21
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/source/results.rst b/docs/source/results.rst
@@ -80,6 +80,10 @@ The `TrainResult` basic usage is this:
 
 minimize
 ^^^^^^^^
+When using TrainResult, the metric that needs to be minimized is passed to this
+argument. Internally, the tensor is verified to contain gradients and `.backward()`
+is called on it.
+
 .. code-block:: python
 
     def training_step(...):