Class VizierServiceClient (1.3.0)

VizierServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.aiplatform_v1beta1.services.vizier_service.transports.base.VizierServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Vertex Vizier API. Vizier service is a GCP service to solve blackbox optimization problems, such as tuning machine learning hyperparameters and searching over deep learning architectures.

Inheritance

builtins.object > VizierServiceClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
VizierServiceTransport	The transport used by the client instance.

Methods

VizierServiceClient

VizierServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.aiplatform_v1beta1.services.vizier_service.transports.base.VizierServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the vizier service client.

Parameters

Name	Description
credentials	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport	`Union[str, VizierServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
client_options	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
client_info	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

add_trial_measurement

add_trial_measurement(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.AddTrialMeasurementRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.AddTrialMeasurementRequest` The request object. Request message for VizierService.AddTrialMeasurement.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.aiplatform_v1beta1.types.Trial	A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.

check_trial_early_stopping_state

check_trial_early_stopping_state(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.CheckTrialEarlyStoppingStateRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a xref_CheckTrialEarlyStoppingStateResponse.

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.CheckTrialEarlyStoppingStateRequest` The request object. Request message for VizierService.CheckTrialEarlyStoppingState.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be CheckTrialEarlyStoppingStateResponse Response message for VizierService.CheckTrialEarlyStoppingState.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

complete_trial

complete_trial(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.CompleteTrialRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Marks a Trial as complete.

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.CompleteTrialRequest` The request object. Request message for VizierService.CompleteTrial.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.aiplatform_v1beta1.types.Trial	A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.

create_study

create_study(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.CreateStudyRequest] = None, *, parent: Optional[str] = None, study: Optional[google.cloud.aiplatform_v1beta1.types.study.Study] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a Study. A resource name will be generated after creation of the Study.

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.CreateStudyRequest` The request object. Request message for VizierService.CreateStudy.
parent	`str` Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
study	`google.cloud.aiplatform_v1beta1.types.Study` Required. The Study configuration used to create the Study. This corresponds to the `study` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.aiplatform_v1beta1.types.Study	A message representing a Study.

create_trial

create_trial(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.CreateTrialRequest] = None, *, parent: Optional[str] = None, trial: Optional[google.cloud.aiplatform_v1beta1.types.study.Trial] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Adds a user provided Trial to a Study.

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.CreateTrialRequest` The request object. Request message for VizierService.CreateTrial.
parent	`str` Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
trial	`google.cloud.aiplatform_v1beta1.types.Trial` Required. The Trial to create. This corresponds to the `trial` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.aiplatform_v1beta1.types.Trial	A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.

custom_job_path

custom_job_path(project: str, location: str, custom_job: str)

Returns a fully-qualified custom_job string.

delete_study

delete_study(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.DeleteStudyRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a Study.

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.DeleteStudyRequest` The request object. Request message for VizierService.DeleteStudy.
name	`str` Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

delete_trial

delete_trial(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.DeleteTrialRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a Trial.

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.DeleteTrialRequest` The request object. Request message for VizierService.DeleteTrial.
name	`str` Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
VizierServiceClient	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter

Name	Description
info	`dict` The service account private key info.

Returns

Type	Description
VizierServiceClient	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
VizierServiceClient	The constructed client.

get_study

get_study(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.GetStudyRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a Study by name.

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.GetStudyRequest` The request object. Request message for VizierService.GetStudy.
name	`str` Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.aiplatform_v1beta1.types.Study	A message representing a Study.

get_trial

get_trial(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.GetTrialRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a Trial.

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.GetTrialRequest` The request object. Request message for VizierService.GetTrial.
name	`str` Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.aiplatform_v1beta1.types.Trial	A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.

list_optimal_trials

list_optimal_trials(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.ListOptimalTrialsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.ListOptimalTrialsRequest` The request object. Request message for VizierService.ListOptimalTrials.
parent	`str` Required. The name of the Study that the optimal Trial belongs to. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.aiplatform_v1beta1.types.ListOptimalTrialsResponse	Response message for VizierService.ListOptimalTrials.

list_studies

list_studies(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.ListStudiesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all the studies in a region for an associated project.

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.ListStudiesRequest` The request object. Request message for VizierService.ListStudies.
parent	`str` Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.aiplatform_v1beta1.services.vizier_service.pagers.ListStudiesPager	Response message for VizierService.ListStudies. Iterating over this object will yield results and resolve additional pages automatically.

list_trials

list_trials(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.ListTrialsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the Trials associated with a Study.

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.ListTrialsRequest` The request object. Request message for VizierService.ListTrials.
parent	`str` Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.aiplatform_v1beta1.services.vizier_service.pagers.ListTrialsPager	Response message for VizierService.ListTrials. Iterating over this object will yield results and resolve additional pages automatically.

lookup_study

lookup_study(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.LookupStudyRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.LookupStudyRequest` The request object. Request message for VizierService.LookupStudy.
parent	`str` Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.aiplatform_v1beta1.types.Study	A message representing a Study.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_custom_job_path

parse_custom_job_path(path: str)

Parses a custom_job path into its component segments.

parse_study_path

parse_study_path(path: str)

Parses a study path into its component segments.

parse_trial_path

parse_trial_path(path: str)

Parses a trial path into its component segments.

stop_trial

stop_trial(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.StopTrialRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Stops a Trial.

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.StopTrialRequest` The request object. Request message for VizierService.StopTrial.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.aiplatform_v1beta1.types.Trial	A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.

study_path

study_path(project: str, location: str, study: str)

Returns a fully-qualified study string.

suggest_trials

suggest_trials(request: Optional[google.cloud.aiplatform_v1beta1.types.vizier_service.SuggestTrialsRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Adds one or more Trials to a Study, with parameter values suggested by Vertex Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a xref_SuggestTrialsResponse.

Parameters

Name	Description
request	`google.cloud.aiplatform_v1beta1.types.SuggestTrialsRequest` The request object. Request message for VizierService.SuggestTrials.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be SuggestTrialsResponse Response message for VizierService.SuggestTrials.

trial_path

trial_path(project: str, location: str, study: str, trial: str)

Returns a fully-qualified trial string.