o .wi@sddlmZddlmZmZmZddlZddlmZddlm Z ddl m Z m Z ddl mZddlmZdd lmZdd lmZmZesGd gZGd d d eZdS))Sequence)AnyOptionalUnionN)Tensor)Literal))_pearsons_contingency_coefficient_compute(_pearsons_contingency_coefficient_update)_nominal_input_validation)Metric)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPE#PearsonsContingencyCoefficient.plotc seZdZUdZdZeed<dZeed<dZeed<dZ e ed<d Z e ed <e ed < d d e deddee deddf fdd Zde de ddfddZde fddZd!dee ee dfdeedefddZZS)"PearsonsContingencyCoefficienta Compute `Pearson's Contingency Coefficient`_ statistic. This metric measures the association between two categorical (nominal) data series. .. math:: Pearson = \sqrt{\frac{\chi^2 / n}{1 + \chi^2 / n}} where .. math:: \chi^2 = \sum_{i,j} \ frac{\left(n_{ij} - \frac{n_{i.} n_{.j}}{n}\right)^2}{\frac{n_{i.} n_{.j}}{n}} where :math:`n_{ij}` denotes the number of times the values :math:`(A_i, B_j)` are observed with :math:`A_i, B_j` represent frequencies of values in ``preds`` and ``target``, respectively. Pearson's Contingency Coefficient is a symmetric coefficient, i.e. :math:`Pearson(preds, target) = Pearson(target, preds)`, so order of input arguments does not matter. The output values lies in [0, 1] with 1 meaning the perfect association. As input to ``forward`` and ``update`` the metric accepts the following input: - ``preds`` (:class:`~torch.Tensor`): Either 1D or 2D tensor of categorical (nominal) data from the first data series with shape ``(batch_size,)`` or ``(batch_size, num_classes)``, respectively. - ``target`` (:class:`~torch.Tensor`): Either 1D or 2D tensor of categorical (nominal) data from the second data series with shape ``(batch_size,)`` or ``(batch_size, num_classes)``, respectively. As output of ``forward`` and ``compute`` the metric returns the following output: - ``pearsons_cc`` (:class:`~torch.Tensor`): Scalar tensor containing the Pearsons Contingency Coefficient statistic. Args: num_classes: Integer specifying the number of classes nan_strategy: Indication of whether to replace or drop ``NaN`` values nan_replace_value: Value to replace ``NaN``s when ``nan_strategy = 'replace'`` kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info. Raises: ValueError: If `nan_strategy` is not one of `'replace'` and `'drop'` ValueError: If `nan_strategy` is equal to `'replace'` and `nan_replace_value` is not an `int` or `float` Example:: >>> from torch import randint, randn >>> from torchmetrics.nominal import PearsonsContingencyCoefficient >>> preds = randint(0, 4, (100,)) >>> target = (preds + randn(100)).round().clamp(0, 4) >>> pearsons_contingency_coefficient = PearsonsContingencyCoefficient(num_classes=5) >>> pearsons_contingency_coefficient(preds, target) tensor(0.6948) Ffull_state_updateis_differentiableThigher_is_betterplot_lower_boundg?plot_upper_boundconfmatreplace num_classes nan_strategy)rdropnan_replace_valuekwargsreturnNc sJtjdi|||_t||||_||_|jdt||dddS)Nrsum)dist_reduce_fx) super__init__rr rr add_statetorchzeros)selfrrrr __class__r!Y/home/ubuntu/sommelier/.venv/lib/python3.10/site-packages/torchmetrics/nominal/pearson.pyr#^s  z'PearsonsContingencyCoefficient.__init__predstargetcCs(t|||j|j|j}|j|7_dS)z*Update state with predictions and targets.N)r rrrr)r'r+r,rr!r!r*updatensz%PearsonsContingencyCoefficient.updatecCs t|jS)z4Compute Pearson's Contingency Coefficient statistic.)rr)r'r!r!r*computeus z&PearsonsContingencyCoefficient.computevalaxcCs |||S)aPlot a single or multiple values from the metric. Args: val: Either a single result from calling `metric.forward` or `metric.compute` or a list of these results. If no value is provided, will automatically call `metric.compute` and plot that result. ax: An matplotlib axis object. If provided will add plot to that axis Returns: Figure and Axes object Raises: ModuleNotFoundError: If `matplotlib` is not installed .. plot:: :scale: 75 >>> # Example plotting a single value >>> import torch >>> from torchmetrics.nominal import PearsonsContingencyCoefficient >>> metric = PearsonsContingencyCoefficient(num_classes=5) >>> metric.update(torch.randint(0, 4, (100,)), torch.randint(0, 4, (100,))) >>> fig_, ax_ = metric.plot() .. plot:: :scale: 75 >>> # Example plotting multiple values >>> import torch >>> from torchmetrics.nominal import PearsonsContingencyCoefficient >>> metric = PearsonsContingencyCoefficient(num_classes=5) >>> values = [ ] >>> for _ in range(10): ... values.append(metric(torch.randint(0, 4, (100,)), torch.randint(0, 4, (100,)))) >>> fig_, ax_ = metric.plot(values) )_plot)r'r/r0r!r!r*plotys &r)rr)NN)__name__ __module__ __qualname____doc__rbool__annotations__rrrfloatrrintrrrr#r-r.rrr rr2 __classcell__r!r!r(r*r"s0  4    2r)collections.abcrtypingrrrr%rtyping_extensionsr'torchmetrics.functional.nominal.pearsonrr %torchmetrics.functional.nominal.utilsr torchmetrics.metricr torchmetrics.utilities.importsr torchmetrics.utilities.plotr r__doctest_skip__rr!r!r!r*s