
    sgҩ                         d dl mZ d dlmZmZmZ d dlmZmZ d dl	Z
ddlmZmZ ddlmZ ddlmZ dd	lmZmZ dd
lmZ ddlmZmZ ddlmZmZ ddlmZ ddlm Z m!Z! ddgZ" G d d      Z#d Z$ G d de      Z% G d de%      Z& G d de%      Z'y)    )abstractmethod)ceilfloorlog)IntegralRealN   )_fit_contextis_classifier)get_scorer_names)resample)Interval
StrOptions)check_classification_targets)_num_samplesvalidate_data   )ParameterGridParameterSampler)BaseSearchCV)_yields_constant_splitscheck_cvHalvingGridSearchCVHalvingRandomSearchCVc                       e Zd ZdZd Zd Zy)_SubsampleMetaSplitterz8Splitter that subsamples a given fraction of the datasetc                <    || _         || _        || _        || _        y Nbase_cvfractionsubsample_testrandom_state)selfr    r!   r"   r#   s        e/var/www/html/venv/lib/python3.12/site-packages/sklearn/model_selection/_search_successive_halving.py__init__z_SubsampleMetaSplitter.__init__   s      ,(    c              +   \  K    | j                   j                  ||fi |D ]  \  }}t        |d| j                  t	        | j
                  t        |      z              }| j                  r8t        |d| j                  t	        | j
                  t        |      z              }||f  y w)NF)replacer#   	n_samples)r    splitr   r#   intr!   lenr"   )r$   Xykwargs	train_idxtest_idxs         r%   r+   z_SubsampleMetaSplitter.split    s     #54<<#5#5a#Ef#E 	&Ix !..dmmc)n<=	I ""#!!%!2!2!$--#h-"?@	 X%%	&s   B*B,N)__name__
__module____qualname____doc__r&   r+    r'   r%   r   r      s    B)&r'   r   c                 J   d | d   | d   | d   fD        \  }}}t        j                  ||k(        }||   }t        j                  t        j                  |      t        j                  t        j
                  |                  }t        j                  ||   || d           S )Nc              3   F   K   | ]  }t        j                  |        y wr   )npasarray).0as     r%   	<genexpr>z_top_k.<locals>.<genexpr>4   s       * 	

1*s   !itermean_test_scoreparams)r:   flatnonzerorollargsortcount_nonzeroisnanarray)	resultskitr	iterationr@   rA   iter_indicesscoressorted_indicess	            r%   _top_krO   2   s    *&/7+<#=wx?PQ*&I >>)s"23L\*F WWRZZ/1A1A"((6BR1STN88F<()<=>>r'   c                       e Zd ZU dZi ej
                   e e e                   e	dgdg e
eddd       edh      g e
eddd       edd	h      geg e
eddd      gd
gdZeed<   ej!                  d       ddddddej$                  ddddddd fd
Zd Zed        Z ed      d fd	       Zd Zed        Z xZS )BaseSuccessiveHalvingzImplements successive halving.

    Ref:
    Almost optimal exploration in multi-armed bandits, ICML 13
    Zohar Karnin, Tomer Koren, Oren Somekh
    Nr#   r   neitherclosedautoexhaustsmallestboolean)scoringr#   max_resourcesmin_resourcesresourcefactoraggressive_elimination_parameter_constraintspre_dispatchT   r*      F)rY   n_jobsrefitcvverboser#   error_scorereturn_train_scorerZ   r[   r\   r]   r^   c          
          t         |   ||||||||	       || _        |
| _        || _        || _        || _        || _        y )N)rY   rc   rd   re   rf   rg   rh   )superr&   r#   rZ   r\   r]   r[   r^   )r$   	estimatorrY   rc   rd   re   rf   r#   rg   rh   rZ   r[   r\   r]   r^   	__class__s                  r%   r&   zBaseSuccessiveHalving.__init__\   s_    $ 	#1 	 		
 )* *&<#r'   c                    t        | j                        st        d      | j                  dk7  r_| j                  | j                  j                         vr9t        d| j                   d| j                  j                  j                         t        | t              r+| j                  | j                  cxk(  rdk(  rt        d       | j                  | _        | j                  dv r| j                  dk(  r | j                  j                  ||fi |}d}||z  | _        t        | j                        rXt        | d	|
      }t!        |       t#        j$                  |      j&                  d   }| xj                  |z  c_        nd| _        | j(                  | _        | j*                  dk(  r*| j                  dk(  st        d      t-        |      | _        | j                  | j*                  kD  r&t        d| j                   d| j*                   d      | j                  dk(  rt        d| j                   d      y )Nz{The cv parameter must yield consistent folds across calls to split(). Set its random_state to an int, or set shuffle=False.r*   zCannot use resource=z% which is not supported by estimator rV   z?n_candidates and min_resources cannot be both set to 'exhaust'.)rW   rV   r	   no_validation)r.   r/   r   r   rU   z:resource can only be 'n_samples' when max_resources='auto'zmin_resources_=z  is greater than max_resources_=.z+: you might have passed an empty dataset X.)r   _checked_cv_orig
ValueErrorr\   rk   
get_paramsrl   r3   
isinstancer   r[   n_candidatesmin_resources_get_n_splitsr   r   r   r:   uniqueshaperZ   max_resources_r   )r$   r.   r/   split_paramsn_splitsmagic_factor	n_classess          r%   _check_input_parametersz-BaseSuccessiveHalving._check_input_parameters   s:    't'<'<=!  MM[(T^^%>%>%@@&t}}o 6  $ 8 8 A ABD 
 d12!!T%6%6C)C !U 	 D #00"99}}+=400==aSlS &.&=# 0%doCA03 "		! 2 21 5I''94'&'# #00&(==K/ P  #/q/D!4!44!$"5"5!6 7''+':':&;1> 
 !#!$"5"5!6 7& &  $r'   c                     t        j                  |d         }t        j                  |d   |k(        }|d   |   }t        j                  |      j	                         rd}||   S t        j
                  |      }||   S )aQ  Custom refit callable to return the index of the best candidate.

        We want the best candidate out of the last iteration. By default
        BaseSearchCV would return the best candidate out of all iterations.

        Currently, we only support for a single metric thus `refit` and
        `refit_metric` are not required.
        r?   r@   r   )r:   maxrB   rF   all	nanargmax)rd   refit_metricrH   	last_iterlast_iter_indicestest_scoresbest_idxs          r%   _select_best_indexz(BaseSuccessiveHalving._select_best_index   s     FF76?+	NN76?i+GH/01BC 88K $$&H !** ||K0H **r'   )prefer_skip_nested_validationc                 `   t        | j                  |t        | j                              | _        | j                  |      }| j                  |||j                  j                         t        |      | _
        t        | 0  |fd|i| | j                  d   | j                     | _        | S )a  Run fit with all sets of parameters.

        Parameters
        ----------

        X : array-like, shape (n_samples, n_features)
            Training vector, where `n_samples` is the number of samples and
            `n_features` is the number of features.

        y : array-like, shape (n_samples,) or (n_samples, n_output), optional
            Target relative to X for classification or regression;
            None for unsupervised learning.

        **params : dict of string -> object
            Parameters passed to the ``fit`` method of the estimator.

        Returns
        -------
        self : object
            Instance of fitted estimator.
        )
classifier)r.   r/   rz   r/   r@   )r   re   r   rk   rp   _get_routed_params_for_fitr~   splitterr+   r   _n_samples_origrj   fitcv_results_best_index_best_score_)r$   r.   r/   rA   routed_paramsrl   s        r%   r   zBaseSuccessiveHalving.fit   s    4 !)GGQ=#@!
 77?$$1=#9#9#?#? 	% 	
  ,AA%%f%  ++,=>t?O?OPr'   c                       j                         } j                  dk7  r-t         fd|D              rt        d j                   d      dt	        t        t        |       j                              z   } j                  dk(  r:|dz
  }t         j                   j                   j                  |z  z         _
        dt	        t         j                   j                  z   j                              z   } j                  r|}nt        ||      } j                  rt        d|        t        d|        t        d	|        t        d
 j                          t        d j                          t        d j                          t        d j                          g  _        g  _        t%        |      D ]  }|} j                  rt        d||z
  |z         }t'         j                  |z   j                  z        }	t        |	 j                        }	 j                   j)                  |	       t        |      }
 j"                  j)                  |
        j                  r5t        d       t        d|        t        d|
        t        d|	         j                  dk(  r1t+         j,                  |	 j.                  z  d j0                        }n?|D cg c]  }|j3                          }}|D ]  }|	| j                  <     j,                  }|g|
z  |	g|
z  d} ||||      }t5        |
 j                  z        }t7        |||      } t        |       _        | _        | _        | _        y c c}w )Nr*   c              3   :   K   | ]  }j                   |v   y wr   )r\   )r<   	candidater$   s     r%   r>   z4BaseSuccessiveHalving._run_search.<locals>.<genexpr>  s      0
+4DMMY&0
s   zCannot use parameter z= as the resource since it is part of the searched parameters.r   rV   zn_iterations: zn_required_iterations: zn_possible_iterations: zmin_resources_: zmax_resources_: zaggressive_elimination: zfactor: r   z
----------ziter: zn_candidates: zn_resources: Tr   )r?   n_resources)more_results) _generate_candidate_paramsr\   anyrq   r   r   r-   r]   r[   r   ru   ry   r^   minrf   printn_resources_n_candidates_ranger,   appendr   rp   r   r#   copyr   rO   n_remaining_candidates_n_required_iterations_n_possible_iterations_n_iterations_)r$   evaluate_candidatescandidate_paramsn_required_iterationslast_iterationn_possible_iterationsn_iterationsrJ   powerr   rt   re   cr   r   rH   n_candidates_to_keeps   `                r%   _run_searchz!BaseSuccessiveHalving._run_search  s   ::<==K'C 0
8H0
 -
 ' 79 9  !"E#c2B.CT[[*Q$R R* 3Q6N"%####t{{N'BB#D !"E##t':'::DKKH%
 !
 &&0L46KLL<<N<.12+,A+BCD+,A+BCD$T%8%8$9:;$T%8%8$9:;,T-H-H,IJKHT[[M*+& 2	JCE**
 As%::=RRSdkk5043F3FFGKk4+>+>?K$$[1/0L%%l3||hsen%|n56k]34}}++ 11(4+?+??#'!%!2!2	 7G#GAFFH#G #G!1 ;I/:Idmm,;** , +}|;L
 * "<G $(t{{(B#C %g/CSIe2	Jh (++;'<$&;#&;#)) $Hs   *Nc                      y r   r7   r$   s    r%   r   z0BaseSuccessiveHalving._generate_candidate_paramsq  s    r'   r   )r3   r4   r5   r6   r   r_   r   setr   callabler   r   strr   dict__annotations__popr:   nanr&   r~   staticmethodr   r
   r   r   r   r   __classcell__rl   s   @r%   rQ   rQ   A   s;   $

-
-$ s#3#5674H'(Xq$y9x 

 Xq$y9	:./
 ED!T)<=#,+$D " ~. FF$!"=H?B + +, &+&	&Pk*Z  r'   rQ   c                        e Zd ZU dZi ej
                  deegiZeed<   dddddd	d
de	j                  dd
d
dd fd
Zd Z xZS )r   a1  Search over specified parameter values with successive halving.

    The search strategy starts evaluating all the candidates with a small
    amount of resources and iteratively selects the best candidates, using
    more and more resources.

    Read more in the :ref:`User guide <successive_halving_user_guide>`.

    .. note::

      This estimator is still **experimental** for now: the predictions
      and the API might change without any deprecation cycle. To use it,
      you need to explicitly import ``enable_halving_search_cv``::

        >>> # explicitly require this experimental feature
        >>> from sklearn.experimental import enable_halving_search_cv # noqa
        >>> # now you can import normally from model_selection
        >>> from sklearn.model_selection import HalvingGridSearchCV

    Parameters
    ----------
    estimator : estimator object
        This is assumed to implement the scikit-learn estimator interface.
        Either estimator needs to provide a ``score`` function,
        or ``scoring`` must be passed.

    param_grid : dict or list of dictionaries
        Dictionary with parameters names (string) as keys and lists of
        parameter settings to try as values, or a list of such
        dictionaries, in which case the grids spanned by each dictionary
        in the list are explored. This enables searching over any sequence
        of parameter settings.

    factor : int or float, default=3
        The 'halving' parameter, which determines the proportion of candidates
        that are selected for each subsequent iteration. For example,
        ``factor=3`` means that only one third of the candidates are selected.

    resource : ``'n_samples'`` or str, default='n_samples'
        Defines the resource that increases with each iteration. By default,
        the resource is the number of samples. It can also be set to any
        parameter of the base estimator that accepts positive integer
        values, e.g. 'n_iterations' or 'n_estimators' for a gradient
        boosting estimator. In this case ``max_resources`` cannot be 'auto'
        and must be set explicitly.

    max_resources : int, default='auto'
        The maximum amount of resource that any candidate is allowed to use
        for a given iteration. By default, this is set to ``n_samples`` when
        ``resource='n_samples'`` (default), else an error is raised.

    min_resources : {'exhaust', 'smallest'} or int, default='exhaust'
        The minimum amount of resource that any candidate is allowed to use
        for a given iteration. Equivalently, this defines the amount of
        resources `r0` that are allocated for each candidate at the first
        iteration.

        - 'smallest' is a heuristic that sets `r0` to a small value:

          - ``n_splits * 2`` when ``resource='n_samples'`` for a regression problem
          - ``n_classes * n_splits * 2`` when ``resource='n_samples'`` for a
            classification problem
          - ``1`` when ``resource != 'n_samples'``

        - 'exhaust' will set `r0` such that the **last** iteration uses as
          much resources as possible. Namely, the last iteration will use the
          highest value smaller than ``max_resources`` that is a multiple of
          both ``min_resources`` and ``factor``. In general, using 'exhaust'
          leads to a more accurate estimator, but is slightly more time
          consuming.

        Note that the amount of resources used at each iteration is always a
        multiple of ``min_resources``.

    aggressive_elimination : bool, default=False
        This is only relevant in cases where there isn't enough resources to
        reduce the remaining candidates to at most `factor` after the last
        iteration. If ``True``, then the search process will 'replay' the
        first iteration for as long as needed until the number of candidates
        is small enough. This is ``False`` by default, which means that the
        last iteration may evaluate more than ``factor`` candidates. See
        :ref:`aggressive_elimination` for more details.

    cv : int, cross-validation generator or iterable, default=5
        Determines the cross-validation splitting strategy.
        Possible inputs for cv are:

        - integer, to specify the number of folds in a `(Stratified)KFold`,
        - :term:`CV splitter`,
        - An iterable yielding (train, test) splits as arrays of indices.

        For integer/None inputs, if the estimator is a classifier and ``y`` is
        either binary or multiclass, :class:`StratifiedKFold` is used. In all
        other cases, :class:`KFold` is used. These splitters are instantiated
        with `shuffle=False` so the splits will be the same across calls.

        Refer :ref:`User Guide <cross_validation>` for the various
        cross-validation strategies that can be used here.

        .. note::
            Due to implementation details, the folds produced by `cv` must be
            the same across multiple calls to `cv.split()`. For
            built-in `scikit-learn` iterators, this can be achieved by
            deactivating shuffling (`shuffle=False`), or by setting the
            `cv`'s `random_state` parameter to an integer.

    scoring : str, callable, or None, default=None
        A single string (see :ref:`scoring_parameter`) or a callable
        (see :ref:`scoring_callable`) to evaluate the predictions on the test set.
        If None, the estimator's score method is used.

    refit : bool, default=True
        If True, refit an estimator using the best found parameters on the
        whole dataset.

        The refitted estimator is made available at the ``best_estimator_``
        attribute and permits using ``predict`` directly on this
        ``HalvingGridSearchCV`` instance.

    error_score : 'raise' or numeric
        Value to assign to the score if an error occurs in estimator fitting.
        If set to 'raise', the error is raised. If a numeric value is given,
        FitFailedWarning is raised. This parameter does not affect the refit
        step, which will always raise the error. Default is ``np.nan``.

    return_train_score : bool, default=False
        If ``False``, the ``cv_results_`` attribute will not include training
        scores.
        Computing training scores is used to get insights on how different
        parameter settings impact the overfitting/underfitting trade-off.
        However computing the scores on the training set can be computationally
        expensive and is not strictly required to select the parameters that
        yield the best generalization performance.

    random_state : int, RandomState instance or None, default=None
        Pseudo random number generator state used for subsampling the dataset
        when `resources != 'n_samples'`. Ignored otherwise.
        Pass an int for reproducible output across multiple function calls.
        See :term:`Glossary <random_state>`.

    n_jobs : int or None, default=None
        Number of jobs to run in parallel.
        ``None`` means 1 unless in a :obj:`joblib.parallel_backend` context.
        ``-1`` means using all processors. See :term:`Glossary <n_jobs>`
        for more details.

    verbose : int
        Controls the verbosity: the higher, the more messages.

    Attributes
    ----------
    n_resources_ : list of int
        The amount of resources used at each iteration.

    n_candidates_ : list of int
        The number of candidate parameters that were evaluated at each
        iteration.

    n_remaining_candidates_ : int
        The number of candidate parameters that are left after the last
        iteration. It corresponds to `ceil(n_candidates[-1] / factor)`

    max_resources_ : int
        The maximum number of resources that any candidate is allowed to use
        for a given iteration. Note that since the number of resources used
        at each iteration must be a multiple of ``min_resources_``, the
        actual number of resources used at the last iteration may be smaller
        than ``max_resources_``.

    min_resources_ : int
        The amount of resources that are allocated for each candidate at the
        first iteration.

    n_iterations_ : int
        The actual number of iterations that were run. This is equal to
        ``n_required_iterations_`` if ``aggressive_elimination`` is ``True``.
        Else, this is equal to ``min(n_possible_iterations_,
        n_required_iterations_)``.

    n_possible_iterations_ : int
        The number of iterations that are possible starting with
        ``min_resources_`` resources and without exceeding
        ``max_resources_``.

    n_required_iterations_ : int
        The number of iterations that are required to end up with less than
        ``factor`` candidates at the last iteration, starting with
        ``min_resources_`` resources. This will be smaller than
        ``n_possible_iterations_`` when there isn't enough resources.

    cv_results_ : dict of numpy (masked) ndarrays
        A dict with keys as column headers and values as columns, that can be
        imported into a pandas ``DataFrame``. It contains lots of information
        for analysing the results of a search.
        Please refer to the :ref:`User guide<successive_halving_cv_results>`
        for details.

    best_estimator_ : estimator or dict
        Estimator that was chosen by the search, i.e. estimator
        which gave highest score (or smallest loss if specified)
        on the left out data. Not available if ``refit=False``.

    best_score_ : float
        Mean cross-validated score of the best_estimator.

    best_params_ : dict
        Parameter setting that gave the best results on the hold out data.

    best_index_ : int
        The index (of the ``cv_results_`` arrays) which corresponds to the best
        candidate parameter setting.

        The dict at ``search.cv_results_['params'][search.best_index_]`` gives
        the parameter setting for the best model, that gives the highest
        mean score (``search.best_score_``).

    scorer_ : function or a dict
        Scorer function used on the held out data to choose the best
        parameters for the model.

    n_splits_ : int
        The number of cross-validation splits (folds/iterations).

    refit_time_ : float
        Seconds used for refitting the best model on the whole dataset.

        This is present only if ``refit`` is not False.

    multimetric_ : bool
        Whether or not the scorers compute several metrics.

    classes_ : ndarray of shape (n_classes,)
        The classes labels. This is present only if ``refit`` is specified and
        the underlying estimator is a classifier.

    n_features_in_ : int
        Number of features seen during :term:`fit`. Only defined if
        `best_estimator_` is defined (see the documentation for the `refit`
        parameter for more details) and that `best_estimator_` exposes
        `n_features_in_` when fit.

        .. versionadded:: 0.24

    feature_names_in_ : ndarray of shape (`n_features_in_`,)
        Names of features seen during :term:`fit`. Only defined if
        `best_estimator_` is defined (see the documentation for the `refit`
        parameter for more details) and that `best_estimator_` exposes
        `feature_names_in_` when fit.

        .. versionadded:: 1.0

    See Also
    --------
    :class:`HalvingRandomSearchCV`:
        Random search over a set of parameters using successive halving.

    Notes
    -----
    The parameters selected are those that maximize the score of the held-out
    data, according to the scoring parameter.

    All parameter combinations scored with a NaN will share the lowest rank.

    Examples
    --------

    >>> from sklearn.datasets import load_iris
    >>> from sklearn.ensemble import RandomForestClassifier
    >>> from sklearn.experimental import enable_halving_search_cv  # noqa
    >>> from sklearn.model_selection import HalvingGridSearchCV
    ...
    >>> X, y = load_iris(return_X_y=True)
    >>> clf = RandomForestClassifier(random_state=0)
    ...
    >>> param_grid = {"max_depth": [3, None],
    ...               "min_samples_split": [5, 10]}
    >>> search = HalvingGridSearchCV(clf, param_grid, resource='n_estimators',
    ...                              max_resources=10,
    ...                              random_state=0).fit(X, y)
    >>> search.best_params_  # doctest: +SKIP
    {'max_depth': None, 'min_samples_split': 10, 'n_estimators': 9}
    
param_gridr_   rb   r*   rU   rV   Fra   NTr   )r]   r\   rZ   r[   r^   re   rY   rd   rg   rh   r#   rc   rf   c                N    t         |   ||	||
||||||||||       || _        y N)rY   rc   rd   rf   re   r#   rg   rh   rZ   r\   r]   r[   r^   )rj   r&   r   )r$   rk   r   r]   r\   rZ   r[   r^   re   rY   rd   rg   rh   r#   rc   rf   rl   s                   r%   r&   zHalvingGridSearchCV.__init__  sJ    & 	%#1''#9 	 	
  %r'   c                 ,    t        | j                        S r   )r   r   r   s    r%   r   z.HalvingGridSearchCV._generate_candidate_params  s    T__--r'   )r3   r4   r5   r6   rQ   r_   r   listr   r:   r   r&   r   r   r   s   @r%   r   r   v  sm    Yv$

6
6$tTl$D  $FF##%J.r'   c                        e Zd ZU dZi ej
                  eeg ee	ddd       e
dh      gdZeed<   dd	d
ddddddej                  ddddd fd
Zd Z xZS )r   a4  Randomized search on hyper parameters.

    The search strategy starts evaluating all the candidates with a small
    amount of resources and iteratively selects the best candidates, using more
    and more resources.

    The candidates are sampled at random from the parameter space and the
    number of sampled candidates is determined by ``n_candidates``.

    Read more in the :ref:`User guide<successive_halving_user_guide>`.

    .. note::

      This estimator is still **experimental** for now: the predictions
      and the API might change without any deprecation cycle. To use it,
      you need to explicitly import ``enable_halving_search_cv``::

        >>> # explicitly require this experimental feature
        >>> from sklearn.experimental import enable_halving_search_cv # noqa
        >>> # now you can import normally from model_selection
        >>> from sklearn.model_selection import HalvingRandomSearchCV

    Parameters
    ----------
    estimator : estimator object
        This is assumed to implement the scikit-learn estimator interface.
        Either estimator needs to provide a ``score`` function,
        or ``scoring`` must be passed.

    param_distributions : dict or list of dicts
        Dictionary with parameters names (`str`) as keys and distributions
        or lists of parameters to try. Distributions must provide a ``rvs``
        method for sampling (such as those from scipy.stats.distributions).
        If a list is given, it is sampled uniformly.
        If a list of dicts is given, first a dict is sampled uniformly, and
        then a parameter is sampled using that dict as above.

    n_candidates : "exhaust" or int, default="exhaust"
        The number of candidate parameters to sample, at the first
        iteration. Using 'exhaust' will sample enough candidates so that the
        last iteration uses as many resources as possible, based on
        `min_resources`, `max_resources` and `factor`. In this case,
        `min_resources` cannot be 'exhaust'.

    factor : int or float, default=3
        The 'halving' parameter, which determines the proportion of candidates
        that are selected for each subsequent iteration. For example,
        ``factor=3`` means that only one third of the candidates are selected.

    resource : ``'n_samples'`` or str, default='n_samples'
        Defines the resource that increases with each iteration. By default,
        the resource is the number of samples. It can also be set to any
        parameter of the base estimator that accepts positive integer
        values, e.g. 'n_iterations' or 'n_estimators' for a gradient
        boosting estimator. In this case ``max_resources`` cannot be 'auto'
        and must be set explicitly.

    max_resources : int, default='auto'
        The maximum number of resources that any candidate is allowed to use
        for a given iteration. By default, this is set ``n_samples`` when
        ``resource='n_samples'`` (default), else an error is raised.

    min_resources : {'exhaust', 'smallest'} or int, default='smallest'
        The minimum amount of resource that any candidate is allowed to use
        for a given iteration. Equivalently, this defines the amount of
        resources `r0` that are allocated for each candidate at the first
        iteration.

        - 'smallest' is a heuristic that sets `r0` to a small value:

          - ``n_splits * 2`` when ``resource='n_samples'`` for a regression problem
          - ``n_classes * n_splits * 2`` when ``resource='n_samples'`` for a
            classification problem
          - ``1`` when ``resource != 'n_samples'``

        - 'exhaust' will set `r0` such that the **last** iteration uses as
          much resources as possible. Namely, the last iteration will use the
          highest value smaller than ``max_resources`` that is a multiple of
          both ``min_resources`` and ``factor``. In general, using 'exhaust'
          leads to a more accurate estimator, but is slightly more time
          consuming. 'exhaust' isn't available when `n_candidates='exhaust'`.

        Note that the amount of resources used at each iteration is always a
        multiple of ``min_resources``.

    aggressive_elimination : bool, default=False
        This is only relevant in cases where there isn't enough resources to
        reduce the remaining candidates to at most `factor` after the last
        iteration. If ``True``, then the search process will 'replay' the
        first iteration for as long as needed until the number of candidates
        is small enough. This is ``False`` by default, which means that the
        last iteration may evaluate more than ``factor`` candidates. See
        :ref:`aggressive_elimination` for more details.

    cv : int, cross-validation generator or an iterable, default=5
        Determines the cross-validation splitting strategy.
        Possible inputs for cv are:

        - integer, to specify the number of folds in a `(Stratified)KFold`,
        - :term:`CV splitter`,
        - An iterable yielding (train, test) splits as arrays of indices.

        For integer/None inputs, if the estimator is a classifier and ``y`` is
        either binary or multiclass, :class:`StratifiedKFold` is used. In all
        other cases, :class:`KFold` is used. These splitters are instantiated
        with `shuffle=False` so the splits will be the same across calls.

        Refer :ref:`User Guide <cross_validation>` for the various
        cross-validation strategies that can be used here.

        .. note::
            Due to implementation details, the folds produced by `cv` must be
            the same across multiple calls to `cv.split()`. For
            built-in `scikit-learn` iterators, this can be achieved by
            deactivating shuffling (`shuffle=False`), or by setting the
            `cv`'s `random_state` parameter to an integer.

    scoring : str, callable, or None, default=None
        A single string (see :ref:`scoring_parameter`) or a callable
        (see :ref:`scoring_callable`) to evaluate the predictions on the test set.
        If None, the estimator's score method is used.

    refit : bool, default=True
        If True, refit an estimator using the best found parameters on the
        whole dataset.

        The refitted estimator is made available at the ``best_estimator_``
        attribute and permits using ``predict`` directly on this
        ``HalvingRandomSearchCV`` instance.

    error_score : 'raise' or numeric
        Value to assign to the score if an error occurs in estimator fitting.
        If set to 'raise', the error is raised. If a numeric value is given,
        FitFailedWarning is raised. This parameter does not affect the refit
        step, which will always raise the error. Default is ``np.nan``.

    return_train_score : bool, default=False
        If ``False``, the ``cv_results_`` attribute will not include training
        scores.
        Computing training scores is used to get insights on how different
        parameter settings impact the overfitting/underfitting trade-off.
        However computing the scores on the training set can be computationally
        expensive and is not strictly required to select the parameters that
        yield the best generalization performance.

    random_state : int, RandomState instance or None, default=None
        Pseudo random number generator state used for subsampling the dataset
        when `resources != 'n_samples'`. Also used for random uniform
        sampling from lists of possible values instead of scipy.stats
        distributions.
        Pass an int for reproducible output across multiple function calls.
        See :term:`Glossary <random_state>`.

    n_jobs : int or None, default=None
        Number of jobs to run in parallel.
        ``None`` means 1 unless in a :obj:`joblib.parallel_backend` context.
        ``-1`` means using all processors. See :term:`Glossary <n_jobs>`
        for more details.

    verbose : int
        Controls the verbosity: the higher, the more messages.

    Attributes
    ----------
    n_resources_ : list of int
        The amount of resources used at each iteration.

    n_candidates_ : list of int
        The number of candidate parameters that were evaluated at each
        iteration.

    n_remaining_candidates_ : int
        The number of candidate parameters that are left after the last
        iteration. It corresponds to `ceil(n_candidates[-1] / factor)`

    max_resources_ : int
        The maximum number of resources that any candidate is allowed to use
        for a given iteration. Note that since the number of resources used at
        each iteration must be a multiple of ``min_resources_``, the actual
        number of resources used at the last iteration may be smaller than
        ``max_resources_``.

    min_resources_ : int
        The amount of resources that are allocated for each candidate at the
        first iteration.

    n_iterations_ : int
        The actual number of iterations that were run. This is equal to
        ``n_required_iterations_`` if ``aggressive_elimination`` is ``True``.
        Else, this is equal to ``min(n_possible_iterations_,
        n_required_iterations_)``.

    n_possible_iterations_ : int
        The number of iterations that are possible starting with
        ``min_resources_`` resources and without exceeding
        ``max_resources_``.

    n_required_iterations_ : int
        The number of iterations that are required to end up with less than
        ``factor`` candidates at the last iteration, starting with
        ``min_resources_`` resources. This will be smaller than
        ``n_possible_iterations_`` when there isn't enough resources.

    cv_results_ : dict of numpy (masked) ndarrays
        A dict with keys as column headers and values as columns, that can be
        imported into a pandas ``DataFrame``. It contains lots of information
        for analysing the results of a search.
        Please refer to the :ref:`User guide<successive_halving_cv_results>`
        for details.

    best_estimator_ : estimator or dict
        Estimator that was chosen by the search, i.e. estimator
        which gave highest score (or smallest loss if specified)
        on the left out data. Not available if ``refit=False``.

    best_score_ : float
        Mean cross-validated score of the best_estimator.

    best_params_ : dict
        Parameter setting that gave the best results on the hold out data.

    best_index_ : int
        The index (of the ``cv_results_`` arrays) which corresponds to the best
        candidate parameter setting.

        The dict at ``search.cv_results_['params'][search.best_index_]`` gives
        the parameter setting for the best model, that gives the highest
        mean score (``search.best_score_``).

    scorer_ : function or a dict
        Scorer function used on the held out data to choose the best
        parameters for the model.

    n_splits_ : int
        The number of cross-validation splits (folds/iterations).

    refit_time_ : float
        Seconds used for refitting the best model on the whole dataset.

        This is present only if ``refit`` is not False.

    multimetric_ : bool
        Whether or not the scorers compute several metrics.

    classes_ : ndarray of shape (n_classes,)
        The classes labels. This is present only if ``refit`` is specified and
        the underlying estimator is a classifier.

    n_features_in_ : int
        Number of features seen during :term:`fit`. Only defined if
        `best_estimator_` is defined (see the documentation for the `refit`
        parameter for more details) and that `best_estimator_` exposes
        `n_features_in_` when fit.

        .. versionadded:: 0.24

    feature_names_in_ : ndarray of shape (`n_features_in_`,)
        Names of features seen during :term:`fit`. Only defined if
        `best_estimator_` is defined (see the documentation for the `refit`
        parameter for more details) and that `best_estimator_` exposes
        `feature_names_in_` when fit.

        .. versionadded:: 1.0

    See Also
    --------
    :class:`HalvingGridSearchCV`:
        Search over a grid of parameters using successive halving.

    Notes
    -----
    The parameters selected are those that maximize the score of the held-out
    data, according to the scoring parameter.

    All parameter combinations scored with a NaN will share the lowest rank.

    Examples
    --------

    >>> from sklearn.datasets import load_iris
    >>> from sklearn.ensemble import RandomForestClassifier
    >>> from sklearn.experimental import enable_halving_search_cv  # noqa
    >>> from sklearn.model_selection import HalvingRandomSearchCV
    >>> from scipy.stats import randint
    >>> import numpy as np
    ...
    >>> X, y = load_iris(return_X_y=True)
    >>> clf = RandomForestClassifier(random_state=0)
    >>> np.random.seed(0)
    ...
    >>> param_distributions = {"max_depth": [3, None],
    ...                        "min_samples_split": randint(2, 11)}
    >>> search = HalvingRandomSearchCV(clf, param_distributions,
    ...                                resource='n_estimators',
    ...                                max_resources=10,
    ...                                random_state=0).fit(X, y)
    >>> search.best_params_  # doctest: +SKIP
    {'max_depth': None, 'min_samples_split': 10, 'n_estimators': 9}
    r   NrR   rS   rV   )param_distributionsrt   r_   rb   r*   rU   rW   Fra   T)rt   r]   r\   rZ   r[   r^   re   rY   rd   rg   rh   r#   rc   rf   c                \    t         |   ||
||||	||||||||       || _        || _        y r   )rj   r&   r   rt   )r$   rk   r   rt   r]   r\   rZ   r[   r^   re   rY   rd   rg   rh   r#   rc   rf   rl   s                    r%   r&   zHalvingRandomSearchCV.__init__  sS    ( 	%#1''#9 	 	
  $7 (r'   c                     | j                   }|dk(  r| j                  | j                  z  }t        | j                  || j
                        S )NrV   )r#   )rt   ry   ru   r   r   r#   )r$   n_candidates_first_iters     r%   r   z0HalvingRandomSearchCV._generate_candidate_params  sQ    "&"3"3"i/ '+&9&9T=P=P&P#$$#**
 	
r'   )r3   r4   r5   r6   rQ   r_   r   r   r   r   r   r   r:   r   r&   r   r   r   s   @r%   r   r     s    jX	$

6
6$ $d|Xq$y9	{#
$D   $FF%%)N

r'   )(abcr   mathr   r   r   numbersr   r   numpyr:   baser
   r   metrics._scorerr   utilsr   utils._param_validationr   r   utils.multiclassr   utils.validationr   r    r   r   _searchr   _splitr   r   __all__r   rO   rQ   r   r   r7   r'   r%   <module>r      sy     ! ! "  . .  : ; : - ! 5 "9
:& &6?rL rj	G./ G.T
g
1 g
r'   