From 39ed1c2408c2b4b7967a7767ed4e396a6e79d8dc Mon Sep 17 00:00:00 2001
From: Andre Anjos <andre.anjos@idiap.ch>
Date: Sun, 5 Apr 2020 11:29:41 +0200
Subject: [PATCH] [engine.trainer] Improve documentation

---
 bob/ip/binseg/engine/trainer.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/bob/ip/binseg/engine/trainer.py b/bob/ip/binseg/engine/trainer.py
index b225f69c..06d55c16 100644
--- a/bob/ip/binseg/engine/trainer.py
+++ b/bob/ip/binseg/engine/trainer.py
@@ -114,9 +114,10 @@ def do_train(
 
             # progress bar only on interactive jobs
             for samples in tqdm(
-                data_loader, desc="batches", leave=False, disable=None
+                data_loader, desc="batches", leave=False, disable=None,
             ):
 
+                # data forwarding on the existing network
                 images = samples[1].to(device)
                 ground_truths = samples[2].to(device)
                 masks = None
@@ -125,6 +126,7 @@ def do_train(
 
                 outputs = model(images)
 
+                # loss evaluation and learning (backward step)
                 loss = criterion(outputs, ground_truths, masks)
                 optimizer.zero_grad()
                 loss.backward()
-- 
GitLab