Experiment

• Implements: IExperiment

This class encapsulates and extends the ROS resource type ALIYUN::PAI::Experiment.

Initializers

import ros_cdk_pai
ros_cdk_pai.Experiment(
  scope: Construct,
  id: str,
  artifact_uri: typing.Union[str, IResolvable],
  experiment_name: typing.Union[str, IResolvable],
  workspace_id: typing.Union[str, IResolvable],
  accessibility: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

artifact_uri^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property artifactUri: ArtifactUri is default OSS storage path of the output of trials in the experiment.

experiment_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property experimentName: Name is the name of the experiment, unique in a namespace.

workspace_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property workspaceId: WorkspaceId is the workspace id which contains the experiment.

accessibility^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property accessibility: Experimental Visibility.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_pai
ros_cdk_pai.Experiment.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_accessibility^Required

attr_accessibility: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Accessibility: Experimental Visibility.

attr_artifact_uri^Required

attr_artifact_uri: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ArtifactUri: ArtifactUri is default OSS storage path of the output of trials in the experiment.

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute CreateTime: GmtCreateTime is time when this entity is created.

attr_experiment_id^Required

attr_experiment_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ExperimentId: ExperimentId is globally unique identifier of the experiment.

attr_experiment_name^Required

attr_experiment_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ExperimentName: Name is the name of the experiment, unique in a namespace.

attr_gmt_modified_time^Required

attr_gmt_modified_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute GmtModifiedTime: GmtModifiedTime is time when this entity is modified.

attr_labels^Required

attr_labels: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Labels: Labels are tags of the experiment.

attr_owner_id^Required

attr_owner_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute OwnerId: OwnerId is the user account id which this entity belongs to.

attr_tensorboard_log_uri^Required

attr_tensorboard_log_uri: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute TensorboardLogUri: TensorboardLogUri is the default OSS storage path of tensorboard log of trials in the experiment.

attr_user_id^Required

attr_user_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute UserId: UserId is the user account id which created this entity.

attr_workspace_id^Required

attr_workspace_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute WorkspaceId: WorkspaceId is the workspace id which contains the experiment.

props^Required

props: ExperimentProps

• Type: ExperimentProps