1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1beta1
  6. Experiment

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.aiplatform/v1beta1.Experiment

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Creates a TensorboardExperiment. Auto-naming is currently not supported for this resource.

    Create Experiment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Experiment(name: string, args: ExperimentArgs, opts?: CustomResourceOptions);
    @overload
    def Experiment(resource_name: str,
                   args: ExperimentArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Experiment(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   tensorboard_experiment_id: Optional[str] = None,
                   tensorboard_id: Optional[str] = None,
                   description: Optional[str] = None,
                   display_name: Optional[str] = None,
                   etag: Optional[str] = None,
                   labels: Optional[Mapping[str, str]] = None,
                   location: Optional[str] = None,
                   project: Optional[str] = None,
                   source: Optional[str] = None)
    func NewExperiment(ctx *Context, name string, args ExperimentArgs, opts ...ResourceOption) (*Experiment, error)
    public Experiment(string name, ExperimentArgs args, CustomResourceOptions? opts = null)
    public Experiment(String name, ExperimentArgs args)
    public Experiment(String name, ExperimentArgs args, CustomResourceOptions options)
    
    type: google-native:aiplatform/v1beta1:Experiment
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ExperimentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ExperimentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ExperimentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExperimentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExperimentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var google_nativeExperimentResource = new GoogleNative.Aiplatform.V1Beta1.Experiment("google-nativeExperimentResource", new()
    {
        TensorboardExperimentId = "string",
        TensorboardId = "string",
        Description = "string",
        DisplayName = "string",
        Etag = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Location = "string",
        Project = "string",
        Source = "string",
    });
    
    example, err := aiplatformv1beta1.NewExperiment(ctx, "google-nativeExperimentResource", &aiplatformv1beta1.ExperimentArgs{
    TensorboardExperimentId: pulumi.String("string"),
    TensorboardId: pulumi.String("string"),
    Description: pulumi.String("string"),
    DisplayName: pulumi.String("string"),
    Etag: pulumi.String("string"),
    Labels: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    Location: pulumi.String("string"),
    Project: pulumi.String("string"),
    Source: pulumi.String("string"),
    })
    
    var google_nativeExperimentResource = new Experiment("google-nativeExperimentResource", ExperimentArgs.builder()        
        .tensorboardExperimentId("string")
        .tensorboardId("string")
        .description("string")
        .displayName("string")
        .etag("string")
        .labels(Map.of("string", "string"))
        .location("string")
        .project("string")
        .source("string")
        .build());
    
    google_native_experiment_resource = google_native.aiplatform.v1beta1.Experiment("google-nativeExperimentResource",
        tensorboard_experiment_id="string",
        tensorboard_id="string",
        description="string",
        display_name="string",
        etag="string",
        labels={
            "string": "string",
        },
        location="string",
        project="string",
        source="string")
    
    const google_nativeExperimentResource = new google_native.aiplatform.v1beta1.Experiment("google-nativeExperimentResource", {
        tensorboardExperimentId: "string",
        tensorboardId: "string",
        description: "string",
        displayName: "string",
        etag: "string",
        labels: {
            string: "string",
        },
        location: "string",
        project: "string",
        source: "string",
    });
    
    type: google-native:aiplatform/v1beta1:Experiment
    properties:
        description: string
        displayName: string
        etag: string
        labels:
            string: string
        location: string
        project: string
        source: string
        tensorboardExperimentId: string
        tensorboardId: string
    

    Experiment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Experiment resource accepts the following input properties:

    TensorboardExperimentId string
    Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    TensorboardId string
    Description string
    Description of this TensorboardExperiment.
    DisplayName string
    User provided name of this TensorboardExperiment.
    Etag string
    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    Labels Dictionary<string, string>
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset: * aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.
    Location string
    Project string
    Source string
    Immutable. Source of the TensorboardExperiment. Example: a custom training job.
    TensorboardExperimentId string
    Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    TensorboardId string
    Description string
    Description of this TensorboardExperiment.
    DisplayName string
    User provided name of this TensorboardExperiment.
    Etag string
    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    Labels map[string]string
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset: * aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.
    Location string
    Project string
    Source string
    Immutable. Source of the TensorboardExperiment. Example: a custom training job.
    tensorboardExperimentId String
    Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    tensorboardId String
    description String
    Description of this TensorboardExperiment.
    displayName String
    User provided name of this TensorboardExperiment.
    etag String
    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    labels Map<String,String>
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset: * aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.
    location String
    project String
    source String
    Immutable. Source of the TensorboardExperiment. Example: a custom training job.
    tensorboardExperimentId string
    Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    tensorboardId string
    description string
    Description of this TensorboardExperiment.
    displayName string
    User provided name of this TensorboardExperiment.
    etag string
    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    labels {[key: string]: string}
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset: * aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.
    location string
    project string
    source string
    Immutable. Source of the TensorboardExperiment. Example: a custom training job.
    tensorboard_experiment_id str
    Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    tensorboard_id str
    description str
    Description of this TensorboardExperiment.
    display_name str
    User provided name of this TensorboardExperiment.
    etag str
    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    labels Mapping[str, str]
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset: * aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.
    location str
    project str
    source str
    Immutable. Source of the TensorboardExperiment. Example: a custom training job.
    tensorboardExperimentId String
    Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    tensorboardId String
    description String
    Description of this TensorboardExperiment.
    displayName String
    User provided name of this TensorboardExperiment.
    etag String
    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    labels Map<String>
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset: * aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.
    location String
    project String
    source String
    Immutable. Source of the TensorboardExperiment. Example: a custom training job.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Experiment resource produces the following output properties:

    CreateTime string
    Timestamp when this TensorboardExperiment was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    UpdateTime string
    Timestamp when this TensorboardExperiment was last updated.
    CreateTime string
    Timestamp when this TensorboardExperiment was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    UpdateTime string
    Timestamp when this TensorboardExperiment was last updated.
    createTime String
    Timestamp when this TensorboardExperiment was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    updateTime String
    Timestamp when this TensorboardExperiment was last updated.
    createTime string
    Timestamp when this TensorboardExperiment was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    updateTime string
    Timestamp when this TensorboardExperiment was last updated.
    create_time str
    Timestamp when this TensorboardExperiment was created.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    update_time str
    Timestamp when this TensorboardExperiment was last updated.
    createTime String
    Timestamp when this TensorboardExperiment was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    updateTime String
    Timestamp when this TensorboardExperiment was last updated.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi