Experiment

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)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	ExperimentProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

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

---

id^Required

• Type: string

---

props^Required

• Type: ExperimentProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

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

---

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

Name	Description
isConstruct	Return whether the given object is a Construct.

---

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

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
ref	string	No description.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this resource is defined.
resource	@alicloud/ros-cdk-core.RosResource	No description.
attrAccessibility	@alicloud/ros-cdk-core.IResolvable	Attribute Accessibility: Experimental Visibility.
attrArtifactUri	@alicloud/ros-cdk-core.IResolvable	Attribute ArtifactUri: ArtifactUri is default OSS storage path of the output of trials in the experiment.
attrCreateTime	@alicloud/ros-cdk-core.IResolvable	Attribute CreateTime: GmtCreateTime is time when this entity is created.
attrExperimentId	@alicloud/ros-cdk-core.IResolvable	Attribute ExperimentId: ExperimentId is globally unique identifier of the experiment.
attrExperimentName	@alicloud/ros-cdk-core.IResolvable	Attribute ExperimentName: Name is the name of the experiment, unique in a namespace.
attrGmtModifiedTime	@alicloud/ros-cdk-core.IResolvable	Attribute GmtModifiedTime: GmtModifiedTime is time when this entity is modified.
attrLabels	@alicloud/ros-cdk-core.IResolvable	Attribute Labels: Labels are tags of the experiment.
attrOwnerId	@alicloud/ros-cdk-core.IResolvable	Attribute OwnerId: OwnerId is the user account id which this entity belongs to.
attrTensorboardLogUri	@alicloud/ros-cdk-core.IResolvable	Attribute TensorboardLogUri: TensorboardLogUri is the default OSS storage path of tensorboard log of trials in the experiment.
attrUserId	@alicloud/ros-cdk-core.IResolvable	Attribute UserId: UserId is the user account id which created this entity.
attrWorkspaceId	@alicloud/ros-cdk-core.IResolvable	Attribute WorkspaceId: WorkspaceId is the workspace id which contains the experiment.

---

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

---

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: IResolvable;

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

Attribute Accessibility: Experimental Visibility.

---

attrArtifactUri^Required

public readonly attrArtifactUri: IResolvable;

• Type: @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: IResolvable;

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

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

---

attrExperimentId^Required

public readonly attrExperimentId: IResolvable;

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

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

---

attrExperimentName^Required

public readonly attrExperimentName: IResolvable;

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

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

---

attrGmtModifiedTime^Required

public readonly attrGmtModifiedTime: IResolvable;

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

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

---

attrLabels^Required

public readonly attrLabels: IResolvable;

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

Attribute Labels: Labels are tags of the experiment.

---

attrOwnerId^Required

public readonly attrOwnerId: IResolvable;

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

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

---

attrTensorboardLogUri^Required

public readonly attrTensorboardLogUri: IResolvable;

• Type: @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: IResolvable;

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

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

---

attrWorkspaceId^Required

public readonly attrWorkspaceId: IResolvable;

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

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

---