From cc8ad9a910b9fabc7ef349770ef2887453a80a05 Mon Sep 17 00:00:00 2001
From: Fahad Khalid <f.khalid@fz-juelich.de>
Date: Tue, 27 Apr 2021 11:13:29 +0200
Subject: [PATCH] Added readme for the PyTorch directory.

---
 pytorch/README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 pytorch/README.md

diff --git a/pytorch/README.md b/pytorch/README.md
new file mode 100644
index 0000000..def300c
--- /dev/null
+++ b/pytorch/README.md
@@ -0,0 +1,20 @@
+# Notes
+
+The source code sample was taken from the Horovod examples repository 
+[here](https://github.com/horovod/horovod/tree/master/examples/pytorch) 
+(last checked: April 27, 2021). The sample has been slightly modified. Our 
+changes are limited to,
+
+*  The data loading mechanism.
+*  Removal of `filelock` to eliminate dependence on a package that is not 
+   available on the supercomputers.
+*  A few additional comments pertaining to our custom data loading mechanism.
+
+**Note:** All newly added statements follow a comment beginning with `[HPCNS]`. 
+All statements that demonstrate the use of Horovod follow a comment beginning 
+with `[Horovod]` (as added by Horovod developers).
+
+The following sample is included:
+
+1.  `mnist.py`: A simple training program for an MNIST classifier that 
+    uses Horovod for data distribution.
-- 
GitLab