Skip to content

Commit bcb1d09

Browse files
andycylmetameta-codesync[bot]
authored andcommitted
Use configure_tracking_metrics to add tracking metrics (#4876)
Summary: Pull Request resolved: #4876 As title Reviewed By: mpolson64 Differential Revision: D92738002 fbshipit-source-id: b8777d4d1deabb2e41f3453b53acf8aa97d1670c
1 parent 31835d4 commit bcb1d09

1 file changed

Lines changed: 8 additions & 11 deletions

File tree

docs/recipes/tracking-metrics.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,20 @@ client.configure_optimization(objective='custom_metric')
2222

2323
## Steps
2424

25-
1. Call `configure_metrics` to add the metrics to your experiment
25+
1. Call `configure_tracking_metrics` to add the metrics to your experiment
2626
2. Attaching data with tracking metrics
2727

28-
### 1. Call `configure_metrics` to add the metrics to your experiment
28+
### 1. Call `configure_tracking_metrics` to add the metrics to your experiment
2929

30-
Call the `add_tracking_metrics` method, passing in the list of metrics we would
31-
like to track.
30+
Call the `configure_tracking_metrics` method, passing in the list of metric
31+
names you would like to track.
3232

33-
When attaching metrics to an experiment, the Client will overwrite existing
34-
metrics on the Experiment with the provided Metric(s) if they share the same
35-
name. If no Metric with the same name exists, the Client will add the Metric as
36-
a tracking metric.
33+
If any of the metrics are already defined on the experiment, they will be
34+
skipped with a warning.
3735

3836
```python
39-
# Add the metrics to the experiment
40-
41-
client.configure_metrics([IMetric(name="my_tracking_metric_1"), IMetric(name="my_tracking_metric_2")])
37+
# Add the tracking metrics to the experiment by name
38+
client.configure_tracking_metrics(["my_tracking_metric_1", "my_tracking_metric_2"])
4239
```
4340

4441
### 2. Attaching data with tracking metrics

0 commit comments

Comments
 (0)