InferenceJob
- Implements: IInferenceJob
This class encapsulates and extends the ROS resource type ALIYUN::PAIPlugin::InferenceJob.
Initializers
import com.aliyun.ros.cdk.paiplugin.InferenceJob;
InferenceJob.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.algorithm(java.lang.String)
.algorithm(IResolvable)
.campaignId(java.lang.String)
.campaignId(IResolvable)
.dataPath(java.lang.String)
.dataPath(IResolvable)
.name(java.lang.String)
.name(IResolvable)
.targetPath(java.lang.String)
.targetPath(IResolvable)
.trainingJobId(java.lang.String)
.trainingJobId(IResolvable)
.userConfig(IResolvable)
.userConfig(java.util.Map<java.lang.String, java.lang.Object>)
// .remark(java.lang.String)
// .remark(IResolvable)
// .waitForInferenceFinish(java.lang.Boolean)
// .waitForInferenceFinish(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
algorithm | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property algorithm: The algorithm of inference job. |
campaignId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property campaignId: The campaign id of inference job. |
dataPath | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dataPath: The input data path of inference job. |
name | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property name: The name of inference job. |
targetPath | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property targetPath: The output result path of inference job. |
trainingJobId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property trainingJobId: The training job id of inference job. |
userConfig | com.aliyun.ros.cdk.core.IResolvable OR java.util.Map | Property userConfig: The user config of inference job. |
remark | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property remark: The remark of inference job. |
waitForInferenceFinish | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property waitForInferenceFinish: Whether resource creation waits for the inference task to complete.The longest waiting time is 40 minutes. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
algorithmRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property algorithm: The algorithm of inference job.
campaignIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property campaignId: The campaign id of inference job.
dataPathRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dataPath: The input data path of inference job.
nameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: The name of inference job.
targetPathRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property targetPath: The output result path of inference job.
trainingJobIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property trainingJobId: The training job id of inference job.
userConfigRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map
Property userConfig: The user config of inference job.
remarkOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property remark: The remark of inference job.
waitForInferenceFinishOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property waitForInferenceFinish: Whether resource creation waits for the inference task to complete.The longest waiting time is 40 minutes.
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.paiplugin.InferenceJob;
InferenceJob.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute GroupId: The related group id of infernce job result. |
attrInferenceJobId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InferenceJobId: The id of inference job. |
props | InferenceJobProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrGroupIdRequired
public java.lang.Object getAttrGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute GroupId: The related group id of infernce job result.
attrInferenceJobIdRequired
public java.lang.Object getAttrInferenceJobId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InferenceJobId: The id of inference job.
propsRequired
public InferenceJobProps getProps();
- Type: InferenceJobProps