Experiment

• Implements: IExperiment

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

Initializers

import { Experiment } from '@alicloud/ros-cdk-pai'
new Experiment(scope: Construct, id: string, props: ExperimentProps, enableResourcePropertyConstraint?: boolean)

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

id^Required

• Type: string

props^Required

• Type: ExperimentProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { Experiment } from '@alicloud/ros-cdk-pai'
Experiment.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

attrAccessibility^Required

public readonly attrAccessibility: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Accessibility: Experimental Visibility.

attrArtifactUri^Required

public readonly attrArtifactUri: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrCreateTime^Required

public readonly attrCreateTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrExperimentId^Required

public readonly attrExperimentId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrExperimentName^Required

public readonly attrExperimentName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrGmtModifiedTime^Required

public readonly attrGmtModifiedTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrLabels^Required

public readonly attrLabels: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Labels: Labels are tags of the experiment.

attrOwnerId^Required

public readonly attrOwnerId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrTensorboardLogUri^Required

public readonly attrTensorboardLogUri: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrUserId^Required

public readonly attrUserId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrWorkspaceId^Required

public readonly attrWorkspaceId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

props^Required

public readonly props: ExperimentProps;

• Type: ExperimentProps