From 12311a0b3f66dca37d1e4a6a16e85b64f2753f82 Mon Sep 17 00:00:00 2001
From: Rares Gaia <ragaia@cisco.com>
Date: Thu, 1 Aug 2024 07:58:06 +0300
Subject: [PATCH] docs: resnet documentation added resnet documentation and
 script usage

---
 examples/resnet/README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 examples/resnet/README.md

diff --git a/examples/resnet/README.md b/examples/resnet/README.md
new file mode 100644
index 0000000..cd26945
--- /dev/null
+++ b/examples/resnet/README.md
@@ -0,0 +1,15 @@
+# Resnet
+
+This script demonstrates how to run a ResNet model on multiple worlds using PyTorch. This script initializes a ResNet model on every worker. The leader sends an image to a worker for inference. After processing the image, the worker sends the predicted class back to the leader.
+
+## Running the Script in a single host
+
+```bash
+python m8d.py --num_workers 1 --backend gloo
+```
+
+## Running the Script in multiple hosts
+
+```bash
+python m8d.py --num_workers 2 --backend nccl --multihost --addr 10.20.1.50 --rank 0
+```