Skip to main content

ExperimentRun

Struct ExperimentRun 

Source
pub struct ExperimentRun {
Show 14 fields pub run_id: RunId, pub recipe: Option<RecipeReference>, pub hyperparameters: Hyperparameters, pub started_at: DateTime<Utc>, pub finished_at: Option<DateTime<Utc>>, pub status: RunStatus, pub hardware: HardwareInfo, pub metrics: Vec<MetricRecord>, pub artifacts: Vec<ArtifactReference>, pub log_uri: Option<String>, pub git_commit: Option<String>, pub git_dirty: bool, pub error_message: Option<String>, pub extra: HashMap<String, Value>,
}
Expand description

An experiment run tracking a training execution.

Fields§

§run_id: RunId

Unique run identifier.

§recipe: Option<RecipeReference>

Recipe used for this run.

§hyperparameters: Hyperparameters

Actual hyperparameters used (may override recipe).

§started_at: DateTime<Utc>

When the run started.

§finished_at: Option<DateTime<Utc>>

When the run finished.

§status: RunStatus

Current status.

§hardware: HardwareInfo

Hardware used.

§metrics: Vec<MetricRecord>

Metrics recorded during training.

§artifacts: Vec<ArtifactReference>

Artifacts produced.

§log_uri: Option<String>

Log URI.

§git_commit: Option<String>

Git commit hash.

§git_dirty: bool

Whether the git working directory was dirty.

§error_message: Option<String>

Error message if failed.

§extra: HashMap<String, Value>

Additional metadata.

Implementations§

Source§

impl ExperimentRun

Source

pub fn new(hyperparameters: Hyperparameters) -> Self

Create a new experiment run.

Source

pub fn from_recipe( recipe: RecipeReference, hyperparameters: Hyperparameters, ) -> Self

Create a run from a recipe.

Source

pub fn start(&mut self)

Start the run.

Source

pub fn complete(&mut self)

Complete the run successfully.

Source

pub fn fail(&mut self, error: impl Into<String>)

Mark the run as failed.

Source

pub fn cancel(&mut self)

Cancel the run.

Source

pub fn log_metric(&mut self, name: impl Into<String>, value: f64, step: u64)

Log a metric.

Source

pub fn get_metric(&self, name: &str) -> Option<f64>

Get the latest value for a metric.

Source

pub fn duration_secs(&self) -> Option<i64>

Get duration in seconds.

Source

pub fn is_finished(&self) -> bool

Check if the run is finished.

Trait Implementations§

Source§

impl Clone for ExperimentRun

Source§

fn clone(&self) -> ExperimentRun

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ExperimentRun

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ExperimentRun

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ExperimentRun

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more