Struct ModelConfig 

#[non_exhaustive]
pub struct ModelConfig {
    pub accept_eula: bool,
    pub hugging_face_access_token: String,
    pub hugging_face_cache_enabled: bool,
    pub model_display_name: String,
    pub container_spec: Option<ModelContainerSpec>,
    pub model_user_id: String,
    /* private fields */
}

Available on crate feature model-garden-service only.

The model config to use for the deployment.

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.

accept_eula: bool

Optional. Whether the user accepts the End User License Agreement (EULA) for the model.

hugging_face_access_token: String

Optional. The Hugging Face read access token used to access the model artifacts of gated models.

hugging_face_cache_enabled: bool

Optional. If true, the model will deploy with a cached version instead of directly downloading the model artifacts from Hugging Face. This is suitable for VPC-SC users with limited internet access.

model_display_name: String

Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.

container_spec: Option<ModelContainerSpec>

Optional. The specification of the container that is to be used when deploying. If not set, the default container spec will be used.

model_user_id: String

Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. When not provided, Vertex AI will generate a value for this ID. When Model Registry model is provided, this field will be ignored.

This value may be up to 63 characters, and valid characters are [a-z0-9_-]. The first character cannot be a number or hyphen.

Implementations

impl ModelConfig

pub fn new() -> Self

pub fn set_accept_eula<T: Into<bool>>(self, v: T) -> Self

Sets the value of accept_eula.

Example

let x = ModelConfig::new().set_accept_eula(true);

pub fn set_hugging_face_access_token<T: Into<String>>(self, v: T) -> Self

Sets the value of hugging_face_access_token.

Example

let x = ModelConfig::new().set_hugging_face_access_token("example");

pub fn set_hugging_face_cache_enabled<T: Into<bool>>(self, v: T) -> Self

Sets the value of hugging_face_cache_enabled.

Example

let x = ModelConfig::new().set_hugging_face_cache_enabled(true);

pub fn set_model_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of model_display_name.

Example

let x = ModelConfig::new().set_model_display_name("example");

pub fn set_container_spec<T>(self, v: T) -> Self

where T: Into<ModelContainerSpec>,

Sets the value of container_spec.

Example

use google_cloud_aiplatform_v1::model::ModelContainerSpec;
let x = ModelConfig::new().set_container_spec(ModelContainerSpec::default()/* use setters */);

pub fn set_or_clear_container_spec<T>(self, v: Option<T>) -> Self

where T: Into<ModelContainerSpec>,

Sets or clears the value of container_spec.

Example

use google_cloud_aiplatform_v1::model::ModelContainerSpec;
let x = ModelConfig::new().set_or_clear_container_spec(Some(ModelContainerSpec::default()/* use setters */));
let x = ModelConfig::new().set_or_clear_container_spec(None::<ModelContainerSpec>);

pub fn set_model_user_id<T: Into<String>>(self, v: T) -> Self

Sets the value of model_user_id.

Example

let x = ModelConfig::new().set_model_user_id("example");

Trait Implementations

impl Clone for ModelConfig

fn clone(&self) -> ModelConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelConfig

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

Formats the value using the given formatter.

impl Default for ModelConfig

fn default() -> ModelConfig

Returns the “default value” for a type.

impl Message for ModelConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ModelConfig

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

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

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 ModelConfig