Class Study (1.24.1)

Version 1.24.1

• 1.48.0 (latest)
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.39.0
• 1.38.1
• 1.37.0
• 1.36.4
• 1.35.0
• 1.34.0
• 1.33.1
• 1.32.0
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.1
• 1.27.1
• 1.26.1
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.1
• 1.18.3
• 1.17.1
• 1.16.1
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.2
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1

Study(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A message representing a Study.

Attributes
Name	Description
name	str Output only. The name of a study. The study's globally unique identifier. Format: projects/{project}/locations/{location}/studies/{study}
display_name	str Required. Describes the Study, default value is empty string.
study_spec	google.cloud.aiplatform_v1beta1.types.StudySpec Required. Configuration of the Study.
state	google.cloud.aiplatform_v1beta1.types.Study.State Output only. The detailed state of a Study.
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time at which the study was created.
inactive_reason	str Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.

Inheritance

builtins.object > proto.message.Message > Study

Classes

State

State(value)

Describes the Study state.

Values: STATE_UNSPECIFIED (0): The study state is unspecified. ACTIVE (1): The study is active. INACTIVE (2): The study is stopped due to an internal error. COMPLETED (3): The study is done when the service exhausts the parameter search space or max_trial_count is reached.