Experiment

• Implements: IExperiment

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

Initializers

import com.aliyun.ros.cdk.pai.Experiment;
Experiment.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .artifactUri(java.lang.String)
    .artifactUri(IResolvable)
    .experimentName(java.lang.String)
    .experimentName(IResolvable)
    .workspaceId(java.lang.String)
    .workspaceId(IResolvable)
//  .accessibility(java.lang.String)
//  .accessibility(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

artifactUri^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

experimentName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

workspaceId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

accessibility^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property accessibility: Experimental Visibility.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.pai.Experiment;
Experiment.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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 java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrAccessibility^Required

public java.lang.Object getAttrAccessibility();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Accessibility: Experimental Visibility.

attrArtifactUri^Required

public java.lang.Object getAttrArtifactUri();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrExperimentId^Required

public java.lang.Object getAttrExperimentId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrExperimentName^Required

public java.lang.Object getAttrExperimentName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrGmtModifiedTime^Required

public java.lang.Object getAttrGmtModifiedTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrLabels^Required

public java.lang.Object getAttrLabels();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Labels: Labels are tags of the experiment.

attrOwnerId^Required

public java.lang.Object getAttrOwnerId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrTensorboardLogUri^Required

public java.lang.Object getAttrTensorboardLogUri();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrUserId^Required

public java.lang.Object getAttrUserId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrWorkspaceId^Required

public java.lang.Object getAttrWorkspaceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

props^Required

public ExperimentProps getProps();

• Type: ExperimentProps