-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Automatically generated by magic modules for service: vertex_ai and r…
…esource: Tensorboards__experiments__run. This commit includes the following changes: - Singular Resource - Plural Resource - Documentation updates - Terraform configuration - Integration tests Signed-off-by: Samir Anand <[email protected]>
- Loading branch information
1 parent
ca02c8e
commit 9969a91
Showing
9 changed files
with
421 additions
and
85 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
docs/resources/google_vertex_ai_tensorboard_experiment_run.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
title: About the google_vertex_ai_tensorboard_experiment_run resource | ||
platform: gcp | ||
--- | ||
|
||
## Syntax | ||
A `google_vertex_ai_tensorboard_experiment_run` is used to test a Google TensorboardExperimentRun resource | ||
|
||
## Examples | ||
``` | ||
describe google_vertex_ai_tensorboard_experiment_run(name: "projects/#{gcp_project_id}/locations/#{tensorboard_experiment_run['region']}/tensorboards/#{tensorboard_experiment_run['tensorboard']}/experiments/#{tensorboard_experiment_run['experiment']}/runs/#{tensorboard_experiment_run['run']}", region: ' value_region') do | ||
it { should exist } | ||
end | ||
describe google_vertex_ai_tensorboard_experiment_run(name: "does_not_exit", region: ' value_region') do | ||
it { should_not exist } | ||
end | ||
``` | ||
|
||
## Properties | ||
Properties that can be accessed from the `google_vertex_ai_tensorboard_experiment_run` resource: | ||
|
||
|
||
* `display_name`: Required. User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment. | ||
|
||
* `update_time`: Output only. Timestamp when this TensorboardRun was last updated. | ||
|
||
* `description`: Description of this TensorboardRun. | ||
|
||
* `etag`: Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | ||
|
||
* `labels`: The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. 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 TensorboardRun (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. | ||
|
||
* `additional_properties`: | ||
|
||
* `create_time`: Output only. Timestamp when this TensorboardRun was created. | ||
|
||
* `name`: Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` | ||
|
||
|
||
## GCP Permissions |
32 changes: 32 additions & 0 deletions
32
docs/resources/google_vertex_ai_tensorboard_experiment_runs.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
title: About the google_vertex_ai_tensorboard_experiment_runs resource | ||
platform: gcp | ||
--- | ||
|
||
## Syntax | ||
A `google_vertex_ai_tensorboard_experiment_runs` is used to test a Google TensorboardExperimentRun resource | ||
|
||
## Examples | ||
``` | ||
describe google_vertex_ai_tensorboard_experiment_runs(parent: "projects/#{gcp_project_id}/locations/#{tensorboard_experiment_run['region']}/tensorboards/#{tensorboard_experiment_run['tensorboard']}/experiments/#{tensorboard_experiment_run['experiment']}", region: ' value_region') do | ||
it { should exist } | ||
end | ||
``` | ||
|
||
## Properties | ||
Properties that can be accessed from the `google_vertex_ai_tensorboard_experiment_runs` resource: | ||
|
||
See [google_vertex_ai_tensorboard_experiment_run.md](google_vertex_ai_tensorboard_experiment_run.md) for more detailed information | ||
* `display_names`: an array of `google_vertex_ai_tensorboard_experiment_run` display_name | ||
* `update_times`: an array of `google_vertex_ai_tensorboard_experiment_run` update_time | ||
* `descriptions`: an array of `google_vertex_ai_tensorboard_experiment_run` description | ||
* `etags`: an array of `google_vertex_ai_tensorboard_experiment_run` etag | ||
* `labels`: an array of `google_vertex_ai_tensorboard_experiment_run` labels | ||
* `create_times`: an array of `google_vertex_ai_tensorboard_experiment_run` create_time | ||
* `names`: an array of `google_vertex_ai_tensorboard_experiment_run` name | ||
|
||
## Filter Criteria | ||
This resource supports all of the above properties as filter criteria, which can be used | ||
with `where` as a block or a method. | ||
|
||
## GCP Permissions |
34 changes: 34 additions & 0 deletions
34
libraries/google/vertexai/property/tensorboardexperimentrun_labels.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# frozen_string_literal: false | ||
|
||
# ---------------------------------------------------------------------------- | ||
# | ||
# *** AUTO GENERATED CODE *** Type: MMv1 *** | ||
# | ||
# ---------------------------------------------------------------------------- | ||
# | ||
# This file is automatically generated by Magic Modules and manual | ||
# changes will be clobbered when the file is regenerated. | ||
# | ||
# Please read more about how to change this file in README.md and | ||
# CONTRIBUTING.md located at the root of this package. | ||
# | ||
# ---------------------------------------------------------------------------- | ||
module GoogleInSpec | ||
module VertexAI | ||
module Property | ||
class TensorboardExperimentRunLabels | ||
attr_reader :additional_properties | ||
|
||
def initialize(args = nil, parent_identifier = nil) | ||
return if args.nil? | ||
@parent_identifier = parent_identifier | ||
@additional_properties = args['additionalProperties'] | ||
end | ||
|
||
def to_s | ||
"#{@parent_identifier} TensorboardExperimentRunLabels" | ||
end | ||
end | ||
end | ||
end | ||
end |
Oops, something went wrong.