tune.noniterative

tune.noniterative.convert

noniterative_objective(func=None, min_better=True)[source]

Parameters

func (Optional[Callable]) –
min_better (bool) –

Return type

Callable[[Any], tune.noniterative.objective.NonIterativeObjectiveFunc]

to_noniterative_objective(obj, min_better=True, global_vars=None, local_vars=None)[source]

Parameters

obj (Any) –
min_better (bool) –
global_vars (Optional[Dict[str, Any]]) –
local_vars (Optional[Dict[str, Any]]) –

Return type

tune.noniterative.objective.NonIterativeObjectiveFunc

tune.noniterative.objective

class NonIterativeObjectiveFunc[source]

Bases: object

generate_sort_metric(value)[source]

Parameters: value (float) –
Return type: float

run(trial)[source]

Parameters: trial (tune.concepts.flow.trial.Trial) –
Return type: tune.concepts.flow.report.TrialReport

safe_run(trial)[source]

Parameters: trial (tune.concepts.flow.trial.Trial) –
Return type: tune.concepts.flow.report.TrialReport

class NonIterativeObjectiveLocalOptimizer[source]

Bases: object

property distributable: bool

run(func, trial, logger)[source]

Parameters

func (tune.noniterative.objective.NonIterativeObjectiveFunc) –
trial (tune.concepts.flow.trial.Trial) –
logger (Any) –

Return type

tune.concepts.flow.report.TrialReport

run_monitored_process(func, trial, stop_checker, logger, interval='60sec')[source]

Parameters

func (tune.noniterative.objective.NonIterativeObjectiveFunc) –
trial (tune.concepts.flow.trial.Trial) –
stop_checker (Callable[[], bool]) –
logger (Any) –
interval (Any) –

Return type

tune.concepts.flow.report.TrialReport

validate_noniterative_objective(func, trial, validator, optimizer=None, logger=None)[source]

Parameters

func (tune.noniterative.objective.NonIterativeObjectiveFunc) –
trial (tune.concepts.flow.trial.Trial) –
validator (Callable[[tune.concepts.flow.report.TrialReport], None]) –
optimizer (Optional[tune.noniterative.objective.NonIterativeObjectiveLocalOptimizer]) –
logger (Optional[Any]) –

Return type

None

tune.noniterative.stopper

class NonIterativeStopper(log_best_only=False)[source]

Bases: tune.concepts.flow.judge.TrialJudge

Parameters: log_best_only (bool) –

can_accept(trial)[source]

Parameters: trial (tune.concepts.flow.trial.Trial) –
Return type: bool

get_reports(trial)[source]

Parameters: trial (tune.concepts.flow.trial.Trial) –
Return type: List[tune.concepts.flow.report.TrialReport]

judge(report)[source]

Parameters: report (tune.concepts.flow.report.TrialReport) –
Return type: tune.concepts.flow.judge.TrialDecision

on_report(report)[source]

Parameters: report (tune.concepts.flow.report.TrialReport) –
Return type: bool

should_stop(trial)[source]

Parameters: trial (tune.concepts.flow.trial.Trial) –
Return type: bool

property updated: bool

class NonIterativeStopperCombiner(left, right, is_and)[source]

Bases: tune.noniterative.stopper.NonIterativeStopper

Parameters

left (tune.noniterative.stopper.NonIterativeStopper) –
right (tune.noniterative.stopper.NonIterativeStopper) –
is_and (bool) –

get_reports(trial)[source]

Parameters: trial (tune.concepts.flow.trial.Trial) –
Return type: List[tune.concepts.flow.report.TrialReport]

on_report(report)[source]

Parameters: report (tune.concepts.flow.report.TrialReport) –
Return type: bool

should_stop(trial)[source]

Parameters: trial (tune.concepts.flow.trial.Trial) –
Return type: bool

class SimpleNonIterativeStopper(partition_should_stop, log_best_only=False)[source]

Bases: tune.noniterative.stopper.NonIterativeStopper

Parameters

partition_should_stop (Callable[[tune.concepts.flow.report.TrialReport, bool, List[tune.concepts.flow.report.TrialReport]], bool]) –
log_best_only (bool) –

on_report(report)[source]

Parameters: report (tune.concepts.flow.report.TrialReport) –
Return type: bool

should_stop(trial)[source]

Parameters: trial (tune.concepts.flow.trial.Trial) –
Return type: bool

class TrialReportCollection(new_best_only=False)[source]

Bases: tune.concepts.flow.report.TrialReportLogger

Parameters: new_best_only (bool) –

log(report)[source]

Parameters: report (tune.concepts.flow.report.TrialReport) –
Return type: None

property reports: List[tune.concepts.flow.report.TrialReport]

n_samples(n)[source]

Parameters: n (int) –
Return type: tune.noniterative.stopper.SimpleNonIterativeStopper

n_updates(n)[source]

Parameters: n (int) –
Return type: tune.noniterative.stopper.SimpleNonIterativeStopper

no_update_period(period)[source]

Parameters: period (Any) –
Return type: tune.noniterative.stopper.SimpleNonIterativeStopper

small_improvement(threshold, updates)[source]

Parameters

threshold (float) –
updates (int) –

Return type

tune.noniterative.stopper.SimpleNonIterativeStopper

tune.noniterative.study

class NonIterativeStudy(objective, optimizer)[source]

Bases: object

Parameters

objective (tune.noniterative.objective.NonIterativeObjectiveFunc) –
optimizer (tune.noniterative.objective.NonIterativeObjectiveLocalOptimizer) –

optimize(dataset, distributed=None, monitor=None, stopper=None, stop_check_interval=None, logger=None)[source]

Parameters

dataset (tune.concepts.dataset.TuneDataset) –
distributed (Optional[bool]) –
monitor (Optional[tune.concepts.flow.judge.Monitor]) –
stopper (Optional[tune.noniterative.stopper.NonIterativeStopper]) –
stop_check_interval (Optional[Any]) –
logger (Optional[Any]) –

Return type

tune.concepts.dataset.StudyResult