&`iBddlZddlZddlmZddlmZddlmZmZm Z m Z m Z m Z ddl ZddlmZmZddlmZmZer ddlmZddlmZGd d eZed Gd deZeGddeZdS)N)ABCMeta)Path) TYPE_CHECKINGAnyDictListOptionalTuple) _atomic_save_load_newest_checkpoint) DeveloperAPI PublicAPI)Trial)Stopperc eZdZdZdedeedeeefdeffd Z e dededeedeeefde f dZ e dededeedeeefdd f d Z e d ed ede fd ZxZS) _CallbackMetazA helper metaclass to ensure container classes (e.g. CallbackList) have implemented all the callback methods (e.g. `on_*`). namebasesattrsreturnct||||}|||||r||||||SN)super__new__ need_checkcheck)mcsrrrcls __class__s e/home/jaya/work/projects/VOICE-AGENT/VIET/agent-env/lib/python3.11/site-packages/ray/tune/callback.pyrz_CallbackMeta.__new__sUggooc466 >>#tUE 2 2 / IIc4 . . . rc.|ddS)NIS_CALLBACK_CONTAINERF)get)rrrrrs r rz_CallbackMeta.need_checksyy0%888r!Nc bt}|D]B}|fdt|DCfd|D}||}|r#t d|d|jd|jddS)Nc3NK|]\}}|||V dSrneed_override_by_subclass.0 attr_nameattrrs r z&_CallbackMeta.check..)sQ#It00DAAr!cFh|]\}}|||Sr'r)s r z&_CallbackMeta.check...sC    4,,Y==    r!zFound missing callback method: z in class .)setupdatevarsitems difference TypeError __module__ __qualname__) rrrrrmethodsbase overriddenmissings ` r rz_CallbackMeta.check#s%%  D NN'+Dzz'7'7'9'9         #(;;==   $$Z00  A'AANAA-0-=AAA   r!r+r,c|do|d p|dkot|S)Non_on_trainer_initsetup) startswithcallable)rr+r,s r r(z'_CallbackMeta.need_override_by_subclass:sT$$U++@!,,->??? $G#  tnn  r!)__name__r8r9__doc__strr typerrr classmethodboolrrr( __classcell__)rs@r rrsL3uT{4S>d99!9*/+9>B38n9 999[9 !*/+>B38n [,#ST[r!rbeta) stabilityceZdZdZgZ ddeddeedeefdZded ed fd Z ded ed fd Z ded ed d d fdZ ded ed d d fdZ ded ed d d fdZ ded ed d d defdZded ed d d fdZded ed d d fdZded ed d d fdZded ed d d ddfdZd ed fdZdeefdZdefdZdS)CallbackaSTune base callback that can be extended and passed to a ``TrialRunner`` Tune callbacks are called from within the ``TrialRunner`` class. There are several hooks that can be used, all of which are found in the submethod definitions of this base class. The parameters passed to the ``**info`` dict vary between hooks. The parameters passed are described in the docstrings of the methods. This example will print a metric each time a result is received: .. testcode:: from ray import tune from ray.tune import Callback class MyCallback(Callback): def on_trial_result(self, iteration, trials, trial, result, **info): print(f"Got result: {result['metric']}") def train_func(config): for i in range(10): tune.report(metric=i) tuner = tune.Tuner( train_func, run_config=tune.RunConfig( callbacks=[MyCallback()] ) ) tuner.fit() .. testoutput:: :hide: ... Nstopr num_samplestotal_num_samplesc dS)aCalled once at the very beginning of training. Any Callback setup should be added here (setting environment variables, etc.) Arguments: stop: Stopping criteria. If ``time_budget_s`` was passed to ``tune.RunConfig``, a ``TimeoutStopper`` will be passed here, either by itself or as a part of a ``CombinedStopper``. num_samples: Number of times to sample from the hyperparameter space. Defaults to 1. If `grid_search` is provided as an argument, the grid will be repeated `num_samples` of times. If this is -1, (virtually) infinite samples are generated until a stopping condition is met. total_num_samples: Total number of samples factoring in grid search samplers. **info: Kwargs dict for forward compatibility. Nr/)selfrOrPrQinfos r rAzCallback.setupvs 4 r! iterationtrialsrc dS)zCalled at the start of each tuning loop step. Arguments: iteration: Number of iterations of the tuning loop. trials: List of trials. **info: Kwargs dict for forward compatibility. Nr/rSrUrVrTs r on_step_beginzCallback.on_step_begins  r!c dS)a/Called at the end of each tuning loop step. The iteration counter is increased before this hook is called. Arguments: iteration: Number of iterations of the tuning loop. trials: List of trials. **info: Kwargs dict for forward compatibility. Nr/rXs r on_step_endzCallback.on_step_ends  r!trialc dS)aCalled after starting a trial instance. Arguments: iteration: Number of iterations of the tuning loop. trials: List of trials. trial: Trial that just has been started. **info: Kwargs dict for forward compatibility. Nr/rSrUrVr\rTs r on_trial_startzCallback.on_trial_starts  r!c dS)aCalled after restoring a trial instance. Arguments: iteration: Number of iterations of the tuning loop. trials: List of trials. trial: Trial that just has been restored. **info: Kwargs dict for forward compatibility. Nr/r^s r on_trial_restorezCallback.on_trial_restore  r!c dS)a$Called after receiving a checkpoint from a trial. Arguments: iteration: Number of iterations of the tuning loop. trials: List of trials. trial: Trial that just saved a checkpoint. **info: Kwargs dict for forward compatibility. Nr/r^s r on_trial_savezCallback.on_trial_saverbr!resultc dS)aCalled after receiving a result from a trial. The search algorithm and scheduler are notified before this hook is called. Arguments: iteration: Number of iterations of the tuning loop. trials: List of trials. trial: Trial that just sent a result. result: Result that the trial sent. **info: Kwargs dict for forward compatibility. Nr/)rSrUrVr\rerTs r on_trial_resultzCallback.on_trial_results ( r!c dS)axCalled after a trial instance completed. The search algorithm and scheduler are notified before this hook is called. Arguments: iteration: Number of iterations of the tuning loop. trials: List of trials. trial: Trial that just has been completed. **info: Kwargs dict for forward compatibility. Nr/r^s r on_trial_completezCallback.on_trial_complete  r!c dS)aCalled after a trial instance failed (errored) but the trial is scheduled for retry. The search algorithm and scheduler are not notified. Arguments: iteration: Number of iterations of the tuning loop. trials: List of trials. trial: Trial that just has errored. **info: Kwargs dict for forward compatibility. Nr/r^s r on_trial_recoverzCallback.on_trial_recoverrjr!c dS)axCalled after a trial instance failed (errored). The search algorithm and scheduler are notified before this hook is called. Arguments: iteration: Number of iterations of the tuning loop. trials: List of trials. trial: Trial that just has errored. **info: Kwargs dict for forward compatibility. Nr/r^s r on_trial_errorzCallback.on_trial_errorrjr! checkpointzray.tune.Checkpointc dS)azCalled after a trial saved a checkpoint with Tune. Arguments: iteration: Number of iterations of the tuning loop. trials: List of trials. trial: Trial that just has errored. checkpoint: Checkpoint object that has been saved by the trial. **info: Kwargs dict for forward compatibility. Nr/)rSrUrVr\rorTs r on_checkpointzCallback.on_checkpoints $ r!c dS)zCalled after experiment is over and all trials have concluded. Arguments: trials: List of trials. **info: Kwargs dict for forward compatibility. Nr/)rSrVrTs r on_experiment_endzCallback.on_experiment_end*s  r!rcdS)a1Get the state of the callback. This method should be implemented by subclasses to return a dictionary representation of the object's current state. This is called automatically by Tune to periodically checkpoint callback state. Upon :ref:`Tune experiment restoration `, callback state will be restored via :meth:`~ray.tune.Callback.set_state`. .. testcode:: from typing import Dict, List, Optional from ray.tune import Callback from ray.tune.experiment import Trial class MyCallback(Callback): def __init__(self): self._trial_ids = set() def on_trial_start( self, iteration: int, trials: List["Trial"], trial: "Trial", **info ): self._trial_ids.add(trial.trial_id) def get_state(self) -> Optional[Dict]: return {"trial_ids": self._trial_ids.copy()} def set_state(self, state: Dict) -> Optional[Dict]: self._trial_ids = state["trial_ids"] Returns: dict: State of the callback. Should be `None` if the callback does not have any state to save (this is the default). Nr/rSs r get_statezCallback.get_state3s Htr!statecdS)aSet the state of the callback. This method should be implemented by subclasses to restore the callback's state based on the given dict state. This is used automatically by Tune to restore checkpoint callback state on :ref:`Tune experiment restoration `. See :meth:`~ray.tune.Callback.get_state` for an example implementation. Args: state: State of the callback. Nr/)rSrws r set_statezCallback.set_stateYrjr!)NNN)rDr8r9rE_SAVED_FILE_TEMPLATESr intrArrYr[r_rardrrgrirlrnrqrsrvryr/r!r rNrNEs''X %)%)+/   y! c] $C=     8 s DM      S  $w-         &*7m  $$$$L t      r!rN) metaclassceZdZdZdZdZdeefdZdZ dZ dZ d Z d Z d Zd Zd ZdZdZdZdZdeefdZdefdZd!dedefdZdefdZdedefdZdefdZdeddfdZ d S)" CallbackListz Call multiple callbacks at once.Tzcallback-states-{}.pkl callbacksc||_dSr _callbacks)rSrs r __init__zCallbackList.__init__qs #r!c |jD]r} |jdi|#t$rU}dt|vr8t jd|jdt|n|Yd}~kd}~wwxYwdS)Nargumentz*Please update `setup` method in callback `z@` to match the method signature in `ray.tune.callback.Callback`.r/)rrAr7rFwarningswarnr FutureWarning)rSrTcallbackes r rAzCallbackList.setupts  H &&&&&&   Q''M<$.<<<&  NN$$$$G%$$$$   s  A8A A33A8c 4|jD]}|jdi|dSNr/)rrYrSrTrs r rYzCallbackList.on_step_begin9 + +H "H " * *T * * * * + +r!c 4|jD]}|jdi|dSr)rr[rs r r[zCallbackList.on_step_ends9 ) )H H ( (4 ( ( ( ( ) )r!c 4|jD]}|jdi|dSr)rr_rs r r_zCallbackList.on_trial_start9 , ,H #H # + +d + + + + , ,r!c 4|jD]}|jdi|dSr)rrars r razCallbackList.on_trial_restore9 . .H %H % - - - - - - . .r!c 4|jD]}|jdi|dSr)rrdrs r rdzCallbackList.on_trial_saverr!c 4|jD]}|jdi|dSr)rrgrs r rgzCallbackList.on_trial_results9 - -H $H $ , ,t , , , , - -r!c 4|jD]}|jdi|dSr)rrirs r rizCallbackList.on_trial_complete9 / /H &H & . . . . . . / /r!c 4|jD]}|jdi|dSr)rrlrs r rlzCallbackList.on_trial_recoverrr!c 4|jD]}|jdi|dSr)rrnrs r rnzCallbackList.on_trial_errorrr!c 4|jD]}|jdi|dSr)rrqrs r rqzCallbackList.on_checkpointrr!c 4|jD]}|jdi|dSr)rrsrs r rszCallbackList.on_experiment_endrr!rci}d}t|jD]"\}}|}|rd}|||<#|sdS|S)zGets the state of all callbacks contained within this list. If there are no stateful callbacks, then None will be returned in order to avoid saving an unnecessary callback checkpoint file.FTN) enumeraterrv)rSrwany_stateful_callbacksircallback_states r rvzCallbackList.get_statesh!&$T_55 & &KAx%//11N .)-&%E!HH% 4 r!rwct|jD]2\}}||d}|r||3dS)zSets the state for all callbacks contained within this list. Skips setting state for all stateless callbacks where `get_state` returned None.N)rrr$ry)rSrwrrrs r ryzCallbackList.set_states[%T_55 3 3KAx"YYq$//N 3"">222 3 3r!defaultcheckpoint_dir session_strc|}|r4|j|}d|}t||||dSdS)zSave the state of the callback list to the checkpoint_dir. Args: checkpoint_dir: directory where the checkpoint is stored. session_str: Unique identifier of the current run session (ex: timestamp). z.tmp-)rwr file_name tmp_file_nameN)rvCKPT_FILE_TMPLformatr )rSrr state_dictrrs r save_to_dirzCallbackList.save_to_dirsu^^%%  +22;??I/I//M  -#+         r!ct||jd}|s"td|||dS)aRestore the state of the list of callbacks from the checkpoint_dir. You should check if it's possible to restore with `can_restore` before calling this method. Args: checkpoint_dir: directory where the checkpoint is stored. Raises: RuntimeError: if unable to find checkpoint. NotImplementedError: if the `set_state` method is not implemented. *z Unable to find checkpoint in {}.N)r rr RuntimeErrorry)rSrrs r restore_from_dirzCallbackList.restore_from_dirsp- D/66s;;   299.II  z"""""r!c ttjt||jdS)zCheck if the checkpoint_dir contains the saved state for this callback list. Returns: can_restore: True if the checkpoint_dir contains a file of the format `CKPT_FILE_TMPL`. False otherwise. r)anyglobiglobrrras_posix)rSrs r can_restorezCallbackList.can_restoresJ JtND,?,F,Fs,K,KLLUUWW X X   r!c*t|jSr)lenrrus r __len__zCallbackList.__len__s4?###r!rrNc|j|Srr)rSrs r __getitem__zCallbackList.__getitem__sq!!r!N)r)!rDr8r9rEr#rrrNrrArYr[r_rardrgrirlrnrqrsr rrvryrFrrrIrr{rrr/r!r r~r~js** -N$$x.$$$$ +++))),,,...+++---///...,,,+++/// 8D>    3t3333#C&#s####,  #  $     $$$$$"S"Z""""""r!r~)rrabcrpathlibrtypingrrrrr r ray.tunerayray.tune.utils.utilr r ray.util.annotationsr rray.tune.experimentrray.tune.stopperrrrNr~r/r!r rs BBBBBBBBBBBBBBBBEEEEEEEE88888888)))))))((((((22222G222j Va a a a a a a a a H U"U"U"U"U"8U"U"U"U"U"r!