Track

Track Storage Protocol

Implement a storage protocol to allow Orion to use track as a storage method.

class orion.storage.track.Track(uri)

Implement a generic protocol to allow Orion to communicate using different storage backend

Parameters

uri: str

Track backend to use for storage; the format is as follow

protocol://[username:password@]host1[:port1][,…hostN[:portN]]][/[database][?options]]

Methods

acquire_algorithm_lock(experiment[, ...])	See orion.storage.base.BaseStorageProtocol.acquire_algorithm_lock()
count_broken_trials(experiment)	Count the number of broken trials
count_completed_trials(experiment)	Count the number of completed trials
create_experiment(config[, algo_locked, ...])	Insert a new experiment inside the database
fetch_experiments(query[, selection])	Fetch all experiments that match the query
fetch_lost_trials(experiment)	Fetch all trials that have a heartbeat older than some given time delta (5 minutes by default)
fetch_noncompleted_trials(experiment)	Fetch all non completed trials
fetch_pending_trials(experiment)	See orion.storage.base.BaseStorageProtocol.fetch_pending_trials()
fetch_trials([experiment, uid, where])	See orion.storage.base.BaseStorageProtocol.fetch_trials()
fetch_trials_by_status(experiment, status)	Fetch all trials with the given status
get_trial([trial, uid, experiment_uid])	See orion.storage.base.BaseStorageProtocol.get_trial()
push_trial_results(trial)	Push the trial's results to the database
register_trial(trial)	Create a new trial to be executed
reserve_trial(experiment)	Select a pending trial and reserve it for the worker
retrieve_result(trial, *args, **kwargs)	Fetch the result from a given medium (file, db, socket, etc..) for a given trial and insert it into the trial object
set_trial_status(trial, status[, heartbeat, was])	Update the trial status and the heartbeat
update_experiment([experiment, uid, where])	See orion.storage.base.BaseStorageProtocol.update_experiment()
update_heartbeat(trial)	Update trial's heartbeat
update_trial([trial, uid, experiment_uid])	Update the fields of a given trials
update_trials([experiment, uid, where])	See orion.storage.base.BaseStorageProtocol.update_trials()

acquire_algorithm_lock(experiment, timeout=60, retry_interval=1)

See orion.storage.base.BaseStorageProtocol.acquire_algorithm_lock()

count_broken_trials(experiment)

Count the number of broken trials

count_completed_trials(experiment)

Count the number of completed trials

create_experiment(config, algo_locked=0, algo_state=None, algo_heartbeat=None)

Insert a new experiment inside the database

fetch_experiments(query, selection=None)

Fetch all experiments that match the query

fetch_lost_trials(experiment)

Fetch all trials that have a heartbeat older than some given time delta (5 minutes by default)

fetch_noncompleted_trials(experiment)

Fetch all non completed trials

fetch_pending_trials(experiment)

See orion.storage.base.BaseStorageProtocol.fetch_pending_trials()

fetch_trials(experiment=None, uid=None, where=None)

See orion.storage.base.BaseStorageProtocol.fetch_trials()

fetch_trials_by_status(experiment, status)

Fetch all trials with the given status

get_trial(trial=None, uid=None, experiment_uid=None)

See orion.storage.base.BaseStorageProtocol.get_trial()

push_trial_results(trial)

Push the trial’s results to the database

register_trial(trial)

Create a new trial to be executed

reserve_trial(experiment)

Select a pending trial and reserve it for the worker

retrieve_result(trial, *args, **kwargs)

Fetch the result from a given medium (file, db, socket, etc..) for a given trial and insert it into the trial object

set_trial_status(trial, status, heartbeat=None, was=None)

Update the trial status and the heartbeat

Raises

FailedUpdate

The exception is raised if the status of the trial object does not match the status in the database

update_experiment(experiment=None, uid=None, where=None, **kwargs)

See orion.storage.base.BaseStorageProtocol.update_experiment()

update_heartbeat(trial)

Update trial’s heartbeat

update_trial(trial=None, uid=None, experiment_uid=None, **kwargs)

Update the fields of a given trials

Parameters

trial: Trial

Trial object to update

where: Optional[dict]

constraint trial must respect

kwargs: dict

a dictionary of fields to update

Returns

returns 1 if the underlying storage was updated else 0

update_trials(experiment=None, uid=None, where=None, **kwargs)

See orion.storage.base.BaseStorageProtocol.update_trials()

class orion.storage.track.TrialAdapter(storage_trial, orion_trial=None, objective=None)

Mock Trial, see Trial

Parameters

storage_trial

Track trial object

orion_trial

Orion trial object

objective: str

objective key

Attributes

end_time

See Trial

experiment

See Trial

gradient

See Trial

hash_params

See Trial

heartbeat

Trial Heartbeat

id

See Trial

objective

See Trial

params

See Trial

parents

See Trial

results

See Trial

status

See Trial

submit_time

See Trial

Methods

to_dict()

See Trial

property end_time

See Trial

property experiment

See Trial

property gradient

See Trial

property hash_params

See Trial

property heartbeat

Trial Heartbeat

property id

See Trial

property objective

See Trial

property params

See Trial

property parents

See Trial

property results

See Trial

property status

See Trial

property submit_time

See Trial

to_dict()

See Trial

orion.storage.track.add_leading_slash(name)

Add leading slash

orion.storage.track.convert_track_status(status)

Convert track status to orion status

orion.storage.track.experiment_uid(exp=None, name=None, version=None)

Return an experiment uid from its name and version for Track

orion.storage.track.get_track_status(val)

Convert orion status to track status

orion.storage.track.remove_leading_slash(name)

Remove leading slash

orion.storage.track.to_epoch(date)

Convert datetime class into seconds since epochs