You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Added reinit__is_reduced and sync_all_reduce docs in metrics doc (#1373)
* added links to reinit__is_reduced and sync_all_reduce decorators in metrics documentation
* updated order in list of metrics
* deleted decorators from metric list
* Update metrics.rst
Co-authored-by: vfdev <[email protected]>
Copy file name to clipboardExpand all lines: docs/source/metrics.rst
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -229,11 +229,11 @@ Complete list of usages
229
229
Metrics and distributed computations
230
230
------------------------------------
231
231
232
-
In the above example, ``CustomAccuracy`` has ``reset``, ``update``, ``compute`` methods
233
-
decorated with ``reinit__is_reduced``, ``sync_all_reduce``. The purpose of these features is to adapt metrics in distributed
234
-
computations on supported backend and devices (:doc:`distributed`). More precisely, in the above example we
235
-
added ``@sync_all_reduce("_num_examples", "_num_correct")`` over ``compute`` method. This means that when ``compute`` method
236
-
is called, metric's interal variables ``self._num_examples`` and ``self._num_correct`` are summed up over all participating
232
+
In the above example, ``CustomAccuracy`` has ``reset``, ``update``, ``compute`` methods decorated
233
+
with :meth:`~ignite.metrics.metric.reinit__is_reduced`, :meth:`~ignite.metrics.metric.sync_all_reduce`. The purpose of these features is to adapt metrics in distributed
234
+
computations on supported backend and devices (see :doc:`distributed` for more details). More precisely, in the above
235
+
example we added ``@sync_all_reduce("_num_examples", "_num_correct")`` over ``compute`` method. This means that when ``compute``
236
+
method is called, metric's interal variables ``self._num_examples`` and ``self._num_correct`` are summed up over all participating
237
237
devices. Therefore, once collected, these internal variables can be used to compute the final metric value.
0 commit comments