o
     ôj�1  ã                   @   s¬   d dl mZ d dlmZmZmZ d dlmZmZ d dl	m
Z
mZmZ d dlmZ d dlmZ d dlmZmZ es<g d¢ZG d	d
„ d
eƒZG dd„ deƒZG dd„ deƒZdS )é    )ÚSequence)ÚAnyÚOptionalÚUnion)ÚTensorÚtensor)Ú*complex_scale_invariant_signal_noise_ratioÚ"scale_invariant_signal_noise_ratioÚsignal_noise_ratio)ÚMetric)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPE)úSignalNoiseRatio.plotú#ScaleInvariantSignalNoiseRatio.plotú*ComplexScaleInvariantSignalNoiseRatio.plotc                       sÚ   e Zd ZU dZdZeed< dZeed< dZeed< e	ed< e	ed< d	Z
ee ed
< d	Zee ed< 	ddededd	f‡ fdd„Zde	de	dd	fdd„Zde	fdd„Z		ddeee	ee	 f  dee defdd„Z‡  ZS )ÚSignalNoiseRatioa3  Calculate `Signal-to-noise ratio`_ (SNR_) meric for evaluating quality of audio.

    .. math::
        \text{SNR} = \frac{P_{signal}}{P_{noise}}

    where  :math:`P` denotes the power of each signal. The SNR metric compares the level of the desired signal to
    the level of background noise. Therefore, a high value of SNR means that the audio is clear.

    As input to `forward` and `update` the metric accepts the following input

    - ``preds`` (:class:`~torch.Tensor`): float tensor with shape ``(...,time)``
    - ``target`` (:class:`~torch.Tensor`): float tensor with shape ``(...,time)``

    As output of `forward` and `compute` the metric returns the following output

    - ``snr`` (:class:`~torch.Tensor`): float scalar tensor with average SNR value over samples

    Args:
        zero_mean: if to zero mean target and preds or not
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Raises:
        TypeError:
            if target and preds have a different shape

    Example:
        >>> from torch import tensor
        >>> from torchmetrics.audio import SignalNoiseRatio
        >>> target = tensor([3.0, -0.5, 2.0, 7.0])
        >>> preds = tensor([2.5, 0.0, 2.0, 8.0])
        >>> snr = SignalNoiseRatio()
        >>> snr(preds, target)
        tensor(16.1805)

    FÚfull_state_updateTÚis_differentiableÚhigher_is_betterÚsum_snrÚtotalNÚplot_lower_boundÚplot_upper_boundÚ	zero_meanÚkwargsÚreturnc                    sD   t ƒ jdi |¤Ž || _| jdtdƒdd� | jdtdƒdd� d S )Nr   ç        Úsum©ÚdefaultÚdist_reduce_fxr   r   © )ÚsuperÚ__init__r   Ú	add_stater   ©Úselfr   r   ©Ú	__class__r"   úi/var/www/html/academy/tools/voices/clone/cosy-venv/lib/python3.10/site-packages/torchmetrics/audio/snr.pyr$   Q   s   zSignalNoiseRatio.__init__ÚpredsÚtargetc                 C   ó8   t ||| jd�}|  j| ¡ 7  _|  j| ¡ 7  _dS ©ú*Update state with predictions and targets.)r+   r,   r   N)r
   r   r   r   r   Únumel)r'   r+   r,   Z	snr_batchr"   r"   r*   Úupdate\   ó   zSignalNoiseRatio.updatec                 C   ó   | j | j S ©zCompute metric.)r   r   ©r'   r"   r"   r*   Úcomputec   ó   zSignalNoiseRatio.computeÚvalÚaxc                 C   ó   |   ||¡S )aþ  Plot 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.audio import SignalNoiseRatio
            >>> metric = SignalNoiseRatio()
            >>> metric.update(torch.rand(4), torch.rand(4))
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> # Example plotting multiple values
            >>> import torch
            >>> from torchmetrics.audio import SignalNoiseRatio
            >>> metric = SignalNoiseRatio()
            >>> values = [ ]
            >>> for _ in range(10):
            ...     values.append(metric(torch.rand(4), torch.rand(4)))
            >>> fig_, ax_ = metric.plot(values)

        ©Ú_plot©r'   r8   r9   r"   r"   r*   Úplotg   s   (r   ©F©NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   ÚboolÚ__annotations__r   r   r   r   r   Úfloatr   r   r$   r1   r6   r   r   r   r   r>   Ú__classcell__r"   r"   r(   r*   r   $   s6   
 $þþýüÿÿÿþr   c                       s²   e Zd ZU dZdZeed< eed< dZdZe	e
 ed< dZe	e
 ed< ded	df‡ fd
d„Zdeded	dfdd„Zd	efdd„Zddeeee df de	e d	efdd„Z‡  ZS )ÚScaleInvariantSignalNoiseRatioa7  Calculate `Scale-invariant signal-to-noise ratio`_ (SI-SNR) metric for evaluating quality of audio.

    As input to `forward` and `update` the metric accepts the following input

    - ``preds`` (:class:`~torch.Tensor`): float tensor with shape ``(...,time)``
    - ``target`` (:class:`~torch.Tensor`): float tensor with shape ``(...,time)``

    As output of `forward` and `compute` the metric returns the following output

    - ``si_snr`` (:class:`~torch.Tensor`): float scalar tensor with average SI-SNR value over samples

    Args:
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Raises:
        TypeError:
            if target and preds have a different shape

    Example:
        >>> import torch
        >>> from torch import tensor
        >>> from torchmetrics.audio import ScaleInvariantSignalNoiseRatio
        >>> target = tensor([3.0, -0.5, 2.0, 7.0])
        >>> preds = tensor([2.5, 0.0, 2.0, 8.0])
        >>> si_snr = ScaleInvariantSignalNoiseRatio()
        >>> si_snr(preds, target)
        tensor(15.0918)

    TÚ
sum_si_snrr   Nr   r   r   r   c                    s>   t ƒ jdi |¤Ž | jdtdƒdd� | jdtdƒdd� d S )NrJ   r   r   r   r   r   r"   )r#   r$   r%   r   )r'   r   r(   r"   r*   r$   ¸   s   z'ScaleInvariantSignalNoiseRatio.__init__r+   r,   c                 C   s4   t ||d�}|  j| ¡ 7  _|  j| ¡ 7  _dS )r/   )r+   r,   N)r	   rJ   r   r   r0   )r'   r+   r,   Zsi_snr_batchr"   r"   r*   r1   Á   s   z%ScaleInvariantSignalNoiseRatio.updatec                 C   r3   r4   )rJ   r   r5   r"   r"   r*   r6   È   r7   z&ScaleInvariantSignalNoiseRatio.computer8   r9   c                 C   r:   )a6  Plot 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.audio import ScaleInvariantSignalNoiseRatio
            >>> metric = ScaleInvariantSignalNoiseRatio()
            >>> metric.update(torch.rand(4), torch.rand(4))
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> # Example plotting multiple values
            >>> import torch
            >>> from torchmetrics.audio import ScaleInvariantSignalNoiseRatio
            >>> metric = ScaleInvariantSignalNoiseRatio()
            >>> values = [ ]
            >>> for _ in range(10):
            ...     values.append(metric(torch.rand(4), torch.rand(4)))
            >>> fig_, ax_ = metric.plot(values)

        r;   r=   r"   r"   r*   r>   Ì   ó   &r   r@   )rA   rB   rC   rD   r   r   rF   r   r   r   rG   r   r   r$   r1   r6   r   r   r   r   r>   rH   r"   r"   r(   r*   rI   ’   s    
 þý	2rI   c                       sº   e Zd ZU dZdZeed< eed< dZdZe	e
 ed< dZe	e
 ed< 	dd	ed
eddf‡ fdd„Zdededdfdd„Zdefdd„Zddeeee df de	e defdd„Z‡  ZS )Ú%ComplexScaleInvariantSignalNoiseRatioaÖ  Calculate `Complex scale-invariant signal-to-noise ratio`_ (C-SI-SNR) metric for evaluating quality of audio.

    As input to `forward` and `update` the metric accepts the following input

    - ``preds`` (:class:`~torch.Tensor`): real float tensor with shape ``(...,frequency,time,2)`` or complex float
      tensor with shape ``(..., frequency,time)``

    - ``target`` (:class:`~torch.Tensor`): real float tensor with shape ``(...,frequency,time,2)`` or complex float
      tensor with shape ``(..., frequency,time)``

    As output of `forward` and `compute` the metric returns the following output

    - ``c_si_snr`` (:class:`~torch.Tensor`): float scalar tensor with average C-SI-SNR value over samples

    Args:
        zero_mean: if to zero mean target and preds or not
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Raises:
        ValueError:
            If ``zero_mean`` is not an bool
        TypeError:
            If ``preds`` is not the shape (..., frequency, time, 2) (after being converted to real if it is complex).
            If ``preds`` and ``target`` does not have the same shape.

    Example:
        >>> from torch import randn
        >>> from torchmetrics.audio import ComplexScaleInvariantSignalNoiseRatio
        >>> preds = randn((1,257,100,2))
        >>> target = randn((1,257,100,2))
        >>> c_si_snr = ComplexScaleInvariantSignalNoiseRatio()
        >>> c_si_snr(preds, target)
        tensor(-38.8832)

    TÚ
ci_snr_sumÚnumNr   r   Fr   r   r   c                    s\   t ƒ jdi |¤Ž t|tƒstd|› �ƒ‚|| _| jdtdƒdd� | jdtdƒdd� d S )	Nz5Expected argument `zero_mean` to be an bool, but got rM   r   r   r   rN   r   r"   )r#   r$   Ú
isinstancerE   Ú
ValueErrorr   r%   r   r&   r(   r"   r*   r$   !  s   
z.ComplexScaleInvariantSignalNoiseRatio.__init__r+   r,   c                 C   r-   r.   )r   r   rM   r   rN   r0   )r'   r+   r,   Úvr"   r"   r*   r1   .  r2   z,ComplexScaleInvariantSignalNoiseRatio.updatec                 C   r3   r4   )rM   rN   r5   r"   r"   r*   r6   5  r7   z-ComplexScaleInvariantSignalNoiseRatio.computer8   r9   c                 C   r:   )az  Plot 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.audio import ComplexScaleInvariantSignalNoiseRatio
            >>> metric = ComplexScaleInvariantSignalNoiseRatio()
            >>> metric.update(torch.rand(1,257,100,2), torch.rand(1,257,100,2))
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> # Example plotting multiple values
            >>> import torch
            >>> from torchmetrics.audio import ComplexScaleInvariantSignalNoiseRatio
            >>> metric = ComplexScaleInvariantSignalNoiseRatio()
            >>> values = [ ]
            >>> for _ in range(10):
            ...     values.append(metric(torch.rand(1,257,100,2), torch.rand(1,257,100,2)))
            >>> fig_, ax_ = metric.plot(values)

        r;   r=   r"   r"   r*   r>   9  rK   r   r?   r@   )rA   rB   rC   rD   r   r   rF   r   r   r   rG   r   rE   r   r$   r1   r6   r   r   r   r   r>   rH   r"   r"   r(   r*   rL   õ   s&   
 $þþýü2rL   N)Úcollections.abcr   Útypingr   r   r   Útorchr   r   Ú!torchmetrics.functional.audio.snrr   r	   r
   Útorchmetrics.metricr   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   rI   rL   r"   r"   r"   r*   Ú<module>   s   nc