Google Cloud Ai Platform V1 Client - Class ModelConfig (1.54.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ModelConfig.

The model config to use for the deployment.

Generated from protobuf message google.cloud.aiplatform.v1.DeployRequest.ModelConfig

Namespace

Google \ Cloud \ AIPlatform \ V1 \ DeployRequest

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ 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`	`Google\Cloud\AIPlatform\V1\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.

getAcceptEula

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

Returns
Type	Description
`bool`

setAcceptEula

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getHuggingFaceAccessToken

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

Returns
Type	Description
`string`

setHuggingFaceAccessToken

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getHuggingFaceCacheEnabled

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.

Returns
Type	Description
`bool`

setHuggingFaceCacheEnabled

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.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getModelDisplayName

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

Returns
Type	Description
`string`

setModelDisplayName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getContainerSpec

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

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\ModelContainerSpec\|null`

hasContainerSpec

clearContainerSpec

setContainerSpec