Model

This class encapsulates and extends the ROS resource type ALIYUN::NLPAUTOML::Model, which is used to create a model.

Initializers

import ros_cdk_nlpautoml
ros_cdk_nlpautoml.Model(
  scope: Construct,
  id: str,
  dataset_id_list: typing.Union[IResolvable, typing.List[typing.Union[typing.Union[int, float], IResolvable]]],
  model_name: typing.Union[str, IResolvable],
  model_type: typing.Union[str, IResolvable],
  project_id: typing.Union[typing.Union[int, float], IResolvable],
  lr: typing.Union[str, IResolvable] = None,
  nepochs: typing.Union[str, IResolvable] = None,
  test_dataset_id_list: typing.Union[IResolvable, typing.List[typing.Union[typing.Union[int, float], IResolvable]]] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
dataset_id_list	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]]]	Property datasetIdList: The uploaded dataset must be under the same project, and the total number of marked data is greater than or equal to 4.
model_name	typing.Union[str, ros_cdk_core.IResolvable]	Property modelName: The name of model.
model_type	typing.Union[str, ros_cdk_core.IResolvable]	Property modelType: The type of model.
project_id	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property projectId: The project id to which the model belongs.
lr	typing.Union[str, ros_cdk_core.IResolvable]	Property lr: Learning rate.
nepochs	typing.Union[str, ros_cdk_core.IResolvable]	Property nepochs: Number of training dataset iterations.
test_dataset_id_list	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]]]	Property testDatasetIdList: Test set ID list.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

dataset_id_list^Required

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

Property datasetIdList: The uploaded dataset must be under the same project, and the total number of marked data is greater than or equal to 4.

---

model_name^Required

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

Property modelName: The name of model.

---

model_type^Required

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

Property modelType: The type of model.

Please refer to the documentation for the parameter values corresponding to different types of models. Using the specified model type under different project, and the backend will do the verification. If the model type does not exist under the project, it will prompt that the base model is not found

---

project_id^Required

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

Property projectId: The project id to which the model belongs.

---

lr^Optional

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

Property lr: Learning rate.

---

nepochs^Optional

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

Property nepochs: Number of training dataset iterations.

---

test_dataset_id_list^Optional

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

Property testDatasetIdList: Test set ID list.

Some models under text classification support adding test set data.

---

enable_resource_property_constraint^Optional

• 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.
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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

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

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

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

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

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

---

is_construct

import ros_cdk_nlpautoml
ros_cdk_nlpautoml.Model.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
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_model_id	ros_cdk_core.IResolvable	Attribute ModelId: The ID of model.
attr_model_version	ros_cdk_core.IResolvable	Attribute ModelVersion: The version of model.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_model_id^Required

attr_model_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ModelId: The ID of model.

---

attr_model_version^Required

attr_model_version: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ModelVersion: The version of model.

---