


"""simple docstring"""





from sklearn.metrics import matthews_corrcoef

import datasets


snake_case__		:     Optional[Any]    				=				'''
Compute the Matthews correlation coefficient (MCC)

The Matthews correlation coefficient is used in machine learning as a
measure of the quality of binary and multiclass classifications. It takes
into account true and false positives and negatives and is generally
regarded as a balanced measure which can be used even if the classes are of
very different sizes. The MCC is in essence a correlation coefficient value
between -1 and +1. A coefficient of +1 represents a perfect prediction, 0
an average random prediction and -1 an inverse prediction.  The statistic
is also known as the phi coefficient. [source: Wikipedia]
'''

snake_case__		:     str    				=				'''
Args:
    predictions (list of int): Predicted labels, as returned by a model.
    references (list of int): Ground truth labels.
    sample_weight (list of int, float, or bool): Sample weights. Defaults to `None`.
Returns:
    matthews_correlation (dict containing float): Matthews correlation.
Examples:
    Example 1, a basic example with only predictions and references as inputs:
        >>> matthews_metric = datasets.load_metric("matthews_correlation")
        >>> results = matthews_metric.compute(references=[1, 3, 2, 0, 3, 2],
        ...                                     predictions=[1, 2, 2, 0, 3, 3])
        >>> print(round(results[\'matthews_correlation\'], 2))
        0.54

    Example 2, the same example as above, but also including sample weights:
        >>> matthews_metric = datasets.load_metric("matthews_correlation")
        >>> results = matthews_metric.compute(references=[1, 3, 2, 0, 3, 2],
        ...                                     predictions=[1, 2, 2, 0, 3, 3],
        ...                                     sample_weight=[0.5, 3, 1, 1, 1, 2])
        >>> print(round(results[\'matthews_correlation\'], 2))
        0.1

    Example 3, the same example as above, but with sample weights that cause a negative correlation:
        >>> matthews_metric = datasets.load_metric("matthews_correlation")
        >>> results = matthews_metric.compute(references=[1, 3, 2, 0, 3, 2],
        ...                                     predictions=[1, 2, 2, 0, 3, 3],
        ...                                     sample_weight=[0.5, 1, 0, 0, 0, 1])
        >>> print(round(results[\'matthews_correlation\'], 2))
        -0.25
'''

snake_case__		:     Optional[int]    				=				'''\
@article{scikit-learn,
  title={Scikit-learn: Machine Learning in {P}ython},
  author={Pedregosa, F. and Varoquaux, G. and Gramfort, A. and Michel, V.
         and Thirion, B. and Grisel, O. and Blondel, M. and Prettenhofer, P.
         and Weiss, R. and Dubourg, V. and Vanderplas, J. and Passos, A. and
         Cournapeau, D. and Brucher, M. and Perrot, M. and Duchesnay, E.},
  journal={Journal of Machine Learning Research},
  volume={12},
  pages={2825--2830},
  year={2011}
}
'''



@datasets.utils.file_utils.add_start_docstrings(_DESCRIPTION							,					_KWARGS_DESCRIPTION			)
class 		snake_case_(       datasets.Metric			):






     def      lowerCamelCase__     (	self  :					Optional[int]				):
           return datasets.MetricInfo(
               description=_DESCRIPTION					,				citation=_CITATION					,				inputs_description=_KWARGS_DESCRIPTION					,				features=datasets.Features(
                   {
                       '''predictions''': datasets.Value('''int32'''				),
                       '''references''': datasets.Value('''int32'''				),
                   }				)					,				reference_urls=[
                   '''https://scikit-learn.org/stable/modules/generated/sklearn.metrics.matthews_corrcoef.html'''
               ]					,				)






     def      lowerCamelCase__     (	self  :					str					,				UpperCamelCase_  :					Any					,				UpperCamelCase_  :					Union[str, Any]					,				UpperCamelCase_  :					Dict=None				):
           return {
               "matthews_correlation": float(matthews_corrcoef(snake_case__					,				snake_case__					,				sample_weight=snake_case__				)				),
           }






"""simple docstring"""





import time
import unittest

from transformers import is_torch_available
from transformers.testing_utils import require_torch, torch_device

from ..test_modeling_common import ids_tensor


if is_torch_available():
 import torch

 from transformers.generation import (
     MaxLengthCriteria,
     MaxNewTokensCriteria,
     MaxTimeCriteria,
     StoppingCriteriaList,
     validate_stopping_criteria,
 )



@require_torch
class 		snake_case_(       unittest.TestCase			):






     def      lowerCamelCase__     (	self  :					int					,				UpperCamelCase_  :					int				):
           lowerCAmelCase					:	str       =   3
           lowerCAmelCase					:	Tuple       =   2_5_0

           lowerCAmelCase					:	Optional[Any]       =   ids_tensor((batch_size, length)					,				UpperCamelCase_				)
           lowerCAmelCase					:	Optional[Any]       =   torch.ones((batch_size, length)					,				device=UpperCamelCase_					,				dtype=torch.float				) / length
           return input_ids, scores






     def      lowerCamelCase__     (	self  :					Optional[Any]				):
           lowerCAmelCase,      lowerCAmelCase					:	Optional[int]       =   self._get_tensors(5				)

           lowerCAmelCase					:	Union[str, Any]       =   StoppingCriteriaList(
               [
                   MaxLengthCriteria(max_length=1_0				),
                   MaxTimeCriteria(max_time=0.1				),
               ]				)

           self.assertFalse(criteria(UpperCamelCase_					,				UpperCamelCase_				)				)

           lowerCAmelCase,      lowerCAmelCase					:	List[str]       =   self._get_tensors(9				)
           self.assertFalse(criteria(UpperCamelCase_					,				UpperCamelCase_				)				)

           lowerCAmelCase,      lowerCAmelCase					:	Any       =   self._get_tensors(1_0				)
           self.assertTrue(criteria(UpperCamelCase_					,				UpperCamelCase_				)				)






     def      lowerCamelCase__     (	self  :					Optional[Any]				):
           lowerCAmelCase					:	Optional[Any]       =   MaxLengthCriteria(max_length=1_0				)

           lowerCAmelCase,      lowerCAmelCase					:	Optional[Any]       =   self._get_tensors(5				)
           self.assertFalse(criteria(UpperCamelCase_					,				UpperCamelCase_				)				)

           lowerCAmelCase,      lowerCAmelCase					:	List[str]       =   self._get_tensors(9				)
           self.assertFalse(criteria(UpperCamelCase_					,				UpperCamelCase_				)				)

           lowerCAmelCase,      lowerCAmelCase					:	str       =   self._get_tensors(1_0				)
           self.assertTrue(criteria(UpperCamelCase_					,				UpperCamelCase_				)				)






     def      lowerCamelCase__     (	self  :					List[Any]				):
           lowerCAmelCase					:	Optional[Any]       =   MaxNewTokensCriteria(start_length=5					,				max_new_tokens=5				)

           lowerCAmelCase,      lowerCAmelCase					:	Optional[int]       =   self._get_tensors(5				)
           self.assertFalse(criteria(UpperCamelCase_					,				UpperCamelCase_				)				)

           lowerCAmelCase,      lowerCAmelCase					:	Union[str, Any]       =   self._get_tensors(9				)
           self.assertFalse(criteria(UpperCamelCase_					,				UpperCamelCase_				)				)

           lowerCAmelCase,      lowerCAmelCase					:	str       =   self._get_tensors(1_0				)
           self.assertTrue(criteria(UpperCamelCase_					,				UpperCamelCase_				)				)

           lowerCAmelCase					:	Dict       =   StoppingCriteriaList([criteria]				)
           self.assertEqual(criteria_list.max_length					,				1_0				)






     def      lowerCamelCase__     (	self  :					Union[str, Any]				):
           lowerCAmelCase,      lowerCAmelCase					:	Tuple       =   self._get_tensors(5				)

           lowerCAmelCase					:	List[str]       =   MaxTimeCriteria(max_time=0.1				)
           self.assertFalse(criteria(UpperCamelCase_					,				UpperCamelCase_				)				)

           lowerCAmelCase					:	List[str]       =   MaxTimeCriteria(max_time=0.1					,				initial_timestamp=time.time() - 0.2				)
           self.assertTrue(criteria(UpperCamelCase_					,				UpperCamelCase_				)				)






     def      lowerCamelCase__     (	self  :					str				):
           validate_stopping_criteria(StoppingCriteriaList([MaxLengthCriteria(1_0				)]				)					,				1_0				)

           with self.assertWarns(UpperCamelCase_				):
                 validate_stopping_criteria(StoppingCriteriaList([MaxLengthCriteria(1_0				)]				)					,				1_1				)

           lowerCAmelCase					:	str       =   validate_stopping_criteria(StoppingCriteriaList()					,				1_1				)

           self.assertEqual(len(UpperCamelCase_				)					,				1				)


