From 778af565048e6160ce59fb5eedd8455e629f7942 Mon Sep 17 00:00:00 2001
From: Yi Wang <wayi@fb.com>
Date: Wed, 1 Sep 2021 17:32:39 -0700
Subject: [PATCH] [DDP Comm Hook] Add debugging communication hooks to
 ddp_comm_hooks.rst (#64352)

Summary:
Pull Request resolved: https://github.com/pytorch/pytorch/pull/64352

as title
ghstack-source-id: 137246253

Test Plan: N/A

Reviewed By: rohan-varma

Differential Revision: D30694089

fbshipit-source-id: a78110b11d59bb0718f43c99ede23f2fd8ab21d0
---
 docs/source/ddp_comm_hooks.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs/source/ddp_comm_hooks.rst b/docs/source/ddp_comm_hooks.rst
index 5bd0378..d0f11fe 100644
--- a/docs/source/ddp_comm_hooks.rst
+++ b/docs/source/ddp_comm_hooks.rst
@@ -84,6 +84,18 @@ PowerSGD Hooks
 .. autofunction:: powerSGD_hook
 .. autofunction:: batched_powerSGD_hook
 
+Debugging Communication Hooks
+-----------------------------
+
+As the name implies, debugging communication hooks are **only** used for debugging and performance optimization purpose.
+
+.. currentmodule:: torch.distributed.algorithms.ddp_comm_hooks.debugging_hooks
+
+.. warning ::
+    Debugging communication hooks do not necessarily output the correct results.
+
+.. autofunction:: noop_hook
+
 Acknowledgements
 ----------------
 
-- 
2.7.4