Skip to content

TrainingJob

This class encapsulates and extends the ROS resource type ALIYUN::PAIPlugin::TrainingJob.

Initializers

import ros_cdk_paiplugin
ros_cdk_paiplugin.TrainingJob(
  scope: Construct,
  id: str,
  algorithm: typing.Union[str, IResolvable],
  campaign_id: typing.Union[str, IResolvable],
  data_path: typing.Union[str, IResolvable],
  name: typing.Union[str, IResolvable],
  user_config: typing.Union[IResolvable, typing.Mapping[typing.Any]],
  remark: typing.Union[str, IResolvable] = None,
  wait_for_training_finish: typing.Union[bool, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
algorithm typing.Union[str, ros_cdk_core.IResolvable] Property algorithm: The algorithm used in training.
campaign_id typing.Union[str, ros_cdk_core.IResolvable] Property campaignId: The related campaign Id.
data_path typing.Union[str, ros_cdk_core.IResolvable] Property dataPath: The training data path in OSS bucket.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of training job.
user_config typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property userConfig: User configuration is used to set parameters such as start_date and end_date to delineate the time range of modeling data.
remark typing.Union[str, ros_cdk_core.IResolvable] Property remark: The remark of training job.
wait_for_training_finish typing.Union[bool, ros_cdk_core.IResolvable] Property waitForTrainingFinish: Whether resource creation waits for the training task to complete.The longest waiting time is 40 minutes.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

algorithmRequired

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

Property algorithm: The algorithm used in training.


campaign_idRequired

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

Property campaignId: The related campaign Id.


data_pathRequired

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

Property dataPath: The training data path in OSS bucket.


nameRequired

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

Property name: The name of training job.


user_configRequired

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property userConfig: User configuration is used to set parameters such as start_date and end_date to delineate the time range of modeling data.


remarkOptional

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

Property remark: The remark of training job.


wait_for_training_finishOptional

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

Property waitForTrainingFinish: Whether resource creation waits for the training task to complete.The longest waiting time is 40 minutes.


enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

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

countRequired

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • 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

nameRequired

  • Type: str

set_metadata

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct

import ros_cdk_paiplugin
ros_cdk_paiplugin.TrainingJob.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_training_job_id typing.Union[str, ros_cdk_core.IResolvable] Attribute TrainingJobId: The training job id.
props TrainingJobProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_training_job_idRequired

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

Attribute TrainingJobId: The training job id.


propsRequired

props: TrainingJobProps

Structs