Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Package vertexai (1.25.0)

API documentation for vertexai package.

Packages Functions

init

init(
    *,
    project: Optional[str] = None,
    location: Optional[str] = None,
    experiment: Optional[str] = None,
    experiment_description: Optional[str] = None,
    experiment_tensorboard: Optional[
        Union[google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard, str]
    ] = None,
    staging_bucket: Optional[str] = None,
    credentials: Optional[google.auth.credentials.Credentials] = None,
    encryption_spec_key_name: Optional[str] = None,
    network: Optional[str] = None
)

Updates common initialization parameters with provided options.

Parameters
Name	Description
`project`	The default project to use when making API calls.
`location`	The default location to use when making API calls. If not set defaults to us-central-1.
`experiment`	Optional. The experiment name.
`experiment_description`	Optional. The description of the experiment.
`experiment_tensorboard`	Optional. The Vertex AI TensorBoard instance, Tensorboard resource name, or Tensorboard resource ID to use as a backing Tensorboard for the provided experiment. Example tensorboard resource name format: "projects/123/locations/us-central1/tensorboards/456" If `experiment_tensorboard` is provided and `experiment` is not, the provided `experiment_tensorboard` will be set as the global Tensorboard. Any subsequent calls to aiplatform.init() with `experiment` and without `experiment_tensorboard` will automatically assign the global Tensorboard to the `experiment`.
`staging_bucket`	The default staging bucket to use to stage artifacts when making API calls. In the form gs://...
`credentials`	The default custom credentials to use when making API calls. If not provided credentials will be ascertained from the environment.
`encryption_spec_key_name`	Optional. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. If set, this resource and all sub-resources will be secured by this key.
`network`	Optional. The full name of the Compute Engine network to which jobs and resources should be peered. E.g. "projects/12345/global/networks/myVPC". Private services access must already be configured for the network. If specified, all eligible jobs and resources created will be peered with this VPC.