Struct Recipe 

#[non_exhaustive]
pub struct Recipe {
    pub schema: String,
    pub version: u32,
    pub leaf: u64,
    pub segments: Vec<RecipeSegment>,
}

The schedule that produced one trial: its lineage as replayable segments.

Built by Study::recipe from parent links and atune.lineage records only — never from reports. The segments run from the start of the leaf’s inherited training to the leaf: the first is a root, a fresh restart, or a child that started without a checkpoint (its event still names the donor), and each later segment continues its predecessor’s checkpoint. to_json is the versioned export ({"schema": "atune.recipe", "version": 1, ...}), byte-for-byte deterministic for one study state.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

schema: String

Always RECIPE_SCHEMA.

version: u32

Always RECIPE_VERSION.

leaf: u64

The per-study number of the trial this recipe produces.

segments: Vec<RecipeSegment>

The segments, from the start of the inherited training to the leaf.

Implementations

impl Recipe

pub fn to_json(&self) -> Result<String>

The versioned JSON export: two-space indented, fields in declaration order, parameters sorted by name, so equal recipes give equal bytes.

Errors

Error::Storage if serialization fails (a non-finite float in a parameter).

pub fn params_at(&self, step: u64) -> &Assignment

The configuration the schedule trains with at step: that of the segment whose [start_step, end_step) contains it, the last segment for any step at or after its start, and the first segment for a step before every start. An empty recipe (never built by Study::recipe) has an empty configuration.

Trait Implementations

impl Clone for Recipe

fn clone(&self) -> Recipe

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Recipe

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Recipe

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Recipe

fn eq(&self, other: &Recipe) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Recipe

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Recipe