# tfma.metrics.MatthewsCorrelationCoefficient

<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/confusion_matrix_metrics.py#L1903-L1938) |

Matthews corrrelation coefficient (MCC).

Inherits From: [`Metric`](https://www.tensorflow.org/tfx/model_analysis/api_docs/python/tfma/metrics/Metric)

    tfma.metrics.MatthewsCorrelationCoefficient(
        thresholds: Optional[Union[float, List[float]]] = None,
        name: Optional[str] = None,
        top_k: Optional[int] = None,
        class_id: Optional[int] = None
    )

<br />

<br />

<br />

| ## Args ||
|---|---|
| `thresholds` | (Optional) Thresholds to use. Defaults to \[0.5\]. |
| `name` | (Optional) Metric name. |
| `top_k` | (Optional) Used with a multi-class model to specify that the top-k values should be used to compute the confusion matrix. The net effect is that the non-top-k values are set to -inf and the matrix is then constructed from the average TP, FP, TN, FN across the classes. When top_k is used, metrics_specs.binarize settings must not be present. Only one of class_id or top_k should be configured. When top_k is set, the default thresholds are \[float('-inf')\]. |
| `class_id` | (Optional) Used with a multi-class model to specify which class to compute the confusion matrix for. When class_id is used, metrics_specs.binarize settings must not be present. Only one of class_id or top_k should be configured. |

<br />

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `compute_confidence_interval` | Whether to compute confidence intervals for this metric. <br /> Note that this may not completely remove the computational overhead involved in computing a given metric. This is only respected by the jackknife confidence interval method. |

<br />

## Methods

### `computations`

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

    computations(
        eval_config: Optional[https://www.tensorflow.org/tfx/model_analysis/api_docs/python/tfma/EvalConfig] = None,
        schema: Optional[schema_pb2.Schema] = None,
        model_names: Optional[List[str]] = None,
        output_names: Optional[List[str]] = None,
        sub_keys: Optional[List[Optional[SubKey]]] = None,
        aggregation_type: Optional[AggregationType] = None,
        class_weights: Optional[Dict[int, float]] = None,
        example_weighted: bool = False,
        query_key: Optional[str] = None
    ) -> https://www.tensorflow.org/tfx/model_analysis/api_docs/python/tfma/metrics/MetricComputations

Creates computations associated with metric.

### `from_config`

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

    @classmethod
    from_config(
        config: Dict[str, Any]
    ) -> 'Metric'

### `get_config`

[View source](https://github.com/tensorflow/model-analysis/blob/v0.46.0/tensorflow_model_analysis/metrics/confusion_matrix_metrics.py#L252-L262)

    get_config() -> Dict[str, Any]

Returns serializable config.

### `result`

[View source](https://github.com/tensorflow/model-analysis/blob/v0.46.0/tensorflow_model_analysis/metrics/confusion_matrix_metrics.py#L1934-L1938)

    result(
        tp: float, tn: float, fp: float, fn: float
    ) -> float

Function for computing metric value from TP, TN, FP, FN values.