Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class TensorboardExperiment.
A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.
Generated from protobuf message google.cloud.aiplatform.v1.TensorboardExperiment
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Name of the TensorboardExperiment. Format: |
↳ display_name |
string
User provided name of this TensorboardExperiment. |
↳ description |
string
Description of this TensorboardExperiment. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp when this TensorboardExperiment was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Timestamp when this TensorboardExperiment was last updated. |
↳ labels |
array|Google\Protobuf\Internal\MapField
The labels with user-defined metadata to organize your Datasets. Label keys and values can be no 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. Following system labels exist for each Dataset: * "aiplatform.googleapis.com/dataset_metadata_schema": - output only, its value is the metadata_schema's title. |
↳ etag |
string
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
↳ source |
string
Immutable. Source of the TensorboardExperiment. Example: a custom training job. |
getName
Output only. Name of the TensorboardExperiment.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Name of the TensorboardExperiment.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
User provided name of this TensorboardExperiment.
Generated from protobuf field string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
User provided name of this TensorboardExperiment.
Generated from protobuf field string display_name = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Description of this TensorboardExperiment.
Generated from protobuf field string description = 3;
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Description of this TensorboardExperiment.
Generated from protobuf field string description = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Timestamp when this TensorboardExperiment was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this TensorboardExperiment was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Timestamp when this TensorboardExperiment was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this TensorboardExperiment was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
The labels with user-defined metadata to organize your Datasets.
Label keys and values can be no 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. Following system labels exist for each Dataset:
- "aiplatform.googleapis.com/dataset_metadata_schema":
- output only, its value is the metadata_schema's title.
Generated from protobuf field map<string, string> labels = 6;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
The labels with user-defined metadata to organize your Datasets.
Label keys and values can be no 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. Following system labels exist for each Dataset:
- "aiplatform.googleapis.com/dataset_metadata_schema":
- output only, its value is the metadata_schema's title.
Generated from protobuf field map<string, string> labels = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEtag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 7;
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSource
Immutable. Source of the TensorboardExperiment. Example: a custom training job.
Generated from protobuf field string source = 8 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
string | |
setSource
Immutable. Source of the TensorboardExperiment. Example: a custom training job.
Generated from protobuf field string source = 8 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |