mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-06 12:20:52 +01:00
a80b215a9a
Summary: Pull Request resolved: https://github.com/pytorch/elastic/pull/148 Pull Request resolved: https://github.com/pytorch/pytorch/pull/56811 Moves docs sphinx `*.rst` files from the torchelastic repository to torch. Note: only moves the rst files the next step is to link it to the main pytorch `index.rst` and write new `examples.rst` Reviewed By: H-Huang Differential Revision: D27974751 fbshipit-source-id: 8ff9f242aa32e0326c37da3916ea0633aa068fc5
32 lines
560 B
ReStructuredText
32 lines
560 B
ReStructuredText
.. _metrics-api:
|
|
|
|
Metrics
|
|
=========
|
|
|
|
.. automodule:: torch.distributed.elastic.metrics
|
|
|
|
|
|
Metric Handlers
|
|
-----------------
|
|
|
|
.. currentmodule:: torch.distributed.elastic.metrics.api
|
|
|
|
Below are the metric handlers that come included with torchelastic.
|
|
|
|
.. autoclass:: MetricHandler
|
|
|
|
.. autoclass:: ConsoleMetricHandler
|
|
|
|
.. autoclass:: NullMetricHandler
|
|
|
|
|
|
|
|
Methods
|
|
------------
|
|
|
|
.. autofunction:: torch.distributed.elastic.metrics.configure
|
|
|
|
.. autofunction:: torch.distributed.elastic.metrics.prof
|
|
|
|
.. autofunction:: torch.distributed.elastic.metrics.put_metric
|