modifying SyncBN doc for FP16 use case (apache#14041)

LGTM
stephenrawls · Feb 16, 2019 · c2dad9a · c2dad9a
1 parent 2134c52
commit c2dad9a
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/python/mxnet/gluon/contrib/nn/basic_layers.py b/python/mxnet/gluon/contrib/nn/basic_layers.py
@@ -165,7 +165,10 @@ class SyncBatchNorm(BatchNorm):
 
     Standard BN [1]_ implementation only normalize the data within each device.
     SyncBN normalizes the input within the whole mini-batch.
-    We follow the sync-onece implmentation described in the paper [2]_.
+    We follow the implementation described in the paper [2]_.
+
+    Note: Current implementation of SyncBN does not support FP16 training.
+    For FP16 inference, use standard nn.BatchNorm instead of SyncBN.
 
     Parameters
     ----------