o
    yi
                  	   @   s   d dl mZ d dlZd dlmZ d dlmZ dededeeef fdd	ZddedededefddZ	ddedededefddZ
dS )    )TupleN)Tensor)_check_same_shapepredstargetreturnc                 C   s0   t | | | | }t|| }| }||fS )zUpdates and returns variables required to compute Mean Squared Error.

    Checks for same shape of input tensors.

    Args:
        preds: Predicted tensor
        target: Ground truth tensor
    )r   torchsumnumel)r   r   diffsum_squared_errorn_obs r   Z/home/ubuntu/.local/lib/python3.10/site-packages/torchmetrics/functional/regression/mse.py_mean_squared_error_update   s
   
	r   Tr   r   squaredc                 C   s   |r| | S t | | S )a  Computes Mean Squared Error.

    Args:
        sum_squared_error: Sum of square of errors over all observations
        n_obs: Number of predictions or observations
        squared: Returns RMSE value if set to False.

    Example:
        >>> preds = torch.tensor([0., 1, 2, 3])
        >>> target = torch.tensor([0., 1, 2, 2])
        >>> sum_squared_error, n_obs = _mean_squared_error_update(preds, target)
        >>> _mean_squared_error_compute(sum_squared_error, n_obs)
        tensor(0.2500)
    )r   sqrt)r   r   r   r   r   r   _mean_squared_error_compute&   s   r   c                 C   s   t | |\}}t|||dS )a  Computes mean squared error.

    Args:
        preds: estimated labels
        target: ground truth labels
        squared: returns RMSE value if set to False

    Return:
        Tensor with MSE

    Example:
        >>> from torchmetrics.functional import mean_squared_error
        >>> x = torch.tensor([0., 1, 2, 3])
        >>> y = torch.tensor([0., 1, 2, 2])
        >>> mean_squared_error(x, y)
        tensor(0.2500)
    )r   )r   r   )r   r   r   r   r   r   r   r   mean_squared_error8   s   r   )T)typingr   r   r   torchmetrics.utilities.checksr   intr   boolr   r   r   r   r   r   <module>   s    