Struct StopInferenceExperimentInput

#[non_exhaustive]
pub struct StopInferenceExperimentInput {
    pub name: Option<String>,
    pub model_variant_actions: Option<HashMap<String, ModelVariantAction>>,
    pub desired_model_variants: Option<Vec<ModelVariantConfig>>,
    pub desired_state: Option<InferenceExperimentStopDesiredState>,
    pub reason: Option<String>,
}

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.

name: Option<String>

The name of the inference experiment to stop.

model_variant_actions: Option<HashMap<String, ModelVariantAction>>

Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

• Promote - Promote the shadow variant to a production variant

• Remove - Delete the variant

• Retain - Keep the variant as it is

desired_model_variants: Option<Vec<ModelVariantConfig>>

An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.

desired_state: Option<InferenceExperimentStopDesiredState>

The desired state of the experiment after stopping. The possible states are the following:

• Completed: The experiment completed successfully

• Cancelled: The experiment was canceled

reason: Option<String>

The reason for stopping the experiment.

Implementations

impl StopInferenceExperimentInput

pub fn name(&self) -> Option<&str>

The name of the inference experiment to stop.

pub fn model_variant_actions( &self, ) -> Option<&HashMap<String, ModelVariantAction>>

Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

• Promote - Promote the shadow variant to a production variant

• Remove - Delete the variant

• Retain - Keep the variant as it is

pub fn desired_model_variants(&self) -> &[ModelVariantConfig]

An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .desired_model_variants.is_none().

pub fn desired_state(&self) -> Option<&InferenceExperimentStopDesiredState>

The desired state of the experiment after stopping. The possible states are the following:

• Completed: The experiment completed successfully

• Cancelled: The experiment was canceled

pub fn reason(&self) -> Option<&str>

The reason for stopping the experiment.

impl StopInferenceExperimentInput

pub fn builder() -> StopInferenceExperimentInputBuilder

Creates a new builder-style object to manufacture StopInferenceExperimentInput.

Trait Implementations

impl Clone for StopInferenceExperimentInput

fn clone(&self) -> StopInferenceExperimentInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StopInferenceExperimentInput

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

Formats the value using the given formatter.

impl PartialEq for StopInferenceExperimentInput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StopInferenceExperimentInput