Skip to content

Commit 52bb624

Browse files
jossperdomovfdev-5
andauthored
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]>
1 parent 391c13a commit 52bb624

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/source/metrics.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -229,11 +229,11 @@ Complete list of usages
229229
Metrics and distributed computations
230230
------------------------------------
231231

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
237237
devices. Therefore, once collected, these internal variables can be used to compute the final metric value.
238238

239239
Complete list of metrics
@@ -262,6 +262,7 @@ Complete list of metrics
262262
- :class:`~ignite.metrics.TopKCategoricalAccuracy`
263263
- :class:`~ignite.metrics.VariableAccumulation`
264264

265+
265266
.. currentmodule:: ignite.metrics
266267

267268
.. autoclass:: Accuracy
@@ -320,6 +321,7 @@ Complete list of metrics
320321

321322
.. currentmodule:: ignite.metrics.metric
322323

324+
.. autofunction:: reinit__is_reduced
325+
323326
.. autofunction:: sync_all_reduce
324327

325-
.. autofunction:: reinit__is_reduced

0 commit comments

Comments
 (0)