Skip to content
This repository has been archived by the owner on Jan 6, 2023. It is now read-only.

Commit

Permalink
fix typo in metrics readme causing error (#32)
Browse files Browse the repository at this point in the history
Summary:
Pull Request resolved: #32

In torchelastic/metrics/api.py the handler is called
ConsoleMetricHandler, but it is ConsoleMetricsHandler (note the extra "s") in the readme which could
cause confusion for users who try to run this code.

Differential Revision: D19456953

fbshipit-source-id: 83be603f27b59b14bbc694ed0b943b7de897c2f7
  • Loading branch information
rohan-varma authored and facebook-github-bot committed Jan 17, 2020
1 parent 6721147 commit 785ce7f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions torchelastic/metrics/README.md
Expand Up @@ -50,8 +50,8 @@ By adding the following configuration metrics in the `torchelastic` and
```python
import torchelastic.metrics as metrics

metrics.configure(metrics.ConsoleMetricsHandler(), group = "torchelastic")
metrics.configure(metrics.ConsoleMetricsHandler(), group = "my_app")
metrics.configure(metrics.ConsoleMetricHandler(), group = "torchelastic")
metrics.configure(metrics.ConsoleMetricHandler(), group = "my_app")
```

#### Implementing a Custom Metric Handler
Expand All @@ -77,4 +77,4 @@ Now all metrics in the group `my_app` will be printed to stdout as:
```
[1574213883.4182858][my_app]: my_metric=<value>
[1574213940.5237644][my_app]: my_metric=<value>
```
```

0 comments on commit 785ce7f

Please sign in to comment.