Method: locations.recommendSpec

Full name: projects.locations.recommendSpec

Gets a Model's spec recommendations. This API is called by UI, SDK, and internal.

Endpoint

post https://{service-endpoint}/v1beta1/{parent}:recommendSpec

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

parent string

Required. The resource name of the Location from which to recommend specs. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.

Request body

The request body contains data with the following structure:

Fields
gcsUri string

Required. The Google Cloud Storage URI of the custom model, storing weights and config files (which can be used to infer the base model).

checkMachineAvailability boolean

Optional. If true, check machine availability for the recommended regions. Only return the machine spec in regions where the machine is available.

checkUserQuota boolean

Optional. If true, check user quota for the recommended regions. Returns all the machine spec in regions they are available, and also the user quota state for each machine type in each region.

Response body

Response message for ModelService.RecommendSpec.

If successful, the response body contains data with the following structure:

Fields
baseModel string

Output only. The base model used to finetune the custom model.

recommendations[] object (Recommendation)

Output only. Recommendations of deployment options for the given custom weights model.

specs[] object (MachineAndModelContainerSpec)

Output only. The machine and model container specs.

JSON representation 
{
  "baseModel": string,
  "recommendations": [
    {
      object (Recommendation)
    }
  ],
  "specs": [
    {
      object (MachineAndModelContainerSpec)
    }
  ]
}

Recommendation

Recommendation of one deployment option for the given custom weights model in one region. Contains the machine and container spec, and user accelerator quota state.

Fields
region string

The region for the deployment spec (machine).

spec object (MachineAndModelContainerSpec)

Output only. The machine and model container specs.

userQuotaState enum (QuotaState)

Output only. The user accelerator quota state.

JSON representation 
{
  "region": string,
  "spec": {
    object (MachineAndModelContainerSpec)
  },
  "userQuotaState": enum (QuotaState)
}

MachineAndModelContainerSpec

A machine and model container spec.

Fields
machineSpec object (MachineSpec)

Output only. The machine spec.

containerSpec object (ModelContainerSpec)

Output only. The model container spec.

JSON representation 
{
  "machineSpec": {
    object (MachineSpec)
  },
  "containerSpec": {
    object (ModelContainerSpec)
  }
}

QuotaState

The user accelerator quota state.

Enums
QUOTA_STATE_UNSPECIFIED Unspecified quota state. Quota information not available.
QUOTA_STATE_USER_HAS_QUOTA user has enough accelerator quota for the machine type.
QUOTA_STATE_NO_USER_QUOTA user does not have enough accelerator quota for the machine type.