# tfma.metrics.MetricKey

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/model-analysis/blob/v0.46.0/tensorflow_model_analysis/metrics/metric_types.py#L241-L366) |

A MetricKey uniquely identifies a metric.

    tfma.metrics.MetricKey(
        name: str,
        model_name: str = '',
        output_name: str = '',
        sub_key: Optional[https://www.tensorflow.org/tfx/model_analysis/api_docs/python/tfma/metrics/SubKey] = None,
        aggregation_type: Optional[AggregationType] = None,
        example_weighted: Optional[bool] = False,
        is_diff: Optional[bool] = False
    )

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `name` | Metric name. Names starting with '*' are private and will be filtered from the final results. Names starting with two underscores, '*_' are reserved for internal use. |
| `model_name` | Optional model name (if multi-model evaluation). |
| `output_name` | Optional output name (if multi-output model type). |
| `sub_key` | Optional sub key. |
| `aggregation_type` | Optional Aggregation type. |
| `example_weighted` | Indicates whether this metric was weighted by examples. |
| `is_diff` | Optional flag to indicate whether this metrics is a diff metric. |

<br />

## Methods

### `from_proto`

[View source](https://github.com/tensorflow/model-analysis/blob/v0.46.0/tensorflow_model_analysis/metrics/metric_types.py#L344-L358)

    @staticmethod
    from_proto(
        pb: metrics_for_slice_pb2.MetricKey
    ) -> 'MetricKey'

Configures class from proto.

### `make_baseline_key`

[View source](https://github.com/tensorflow/model-analysis/blob/v0.46.0/tensorflow_model_analysis/metrics/metric_types.py#L365-L366)

    make_baseline_key(
        model_name: str
    ) -> 'MetricKey'

### `make_diff_key`

[View source](https://github.com/tensorflow/model-analysis/blob/v0.46.0/tensorflow_model_analysis/metrics/metric_types.py#L361-L362)

    make_diff_key() -> 'MetricKey'

### `to_proto`

[View source](https://github.com/tensorflow/model-analysis/blob/v0.46.0/tensorflow_model_analysis/metrics/metric_types.py#L325-L342)

    to_proto() -> metrics_for_slice_pb2.MetricKey

Converts key to proto.