ModelVersion

• Implements: IModelVersion

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

Initializers

import ros_cdk_pai
ros_cdk_pai.ModelVersion(
  scope: Construct,
  id: str,
  model_id: typing.Union[str, IResolvable],
  uri: typing.Union[str, IResolvable],
  approval_status: typing.Union[str, IResolvable] = None,
  extra_info: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  format_type: typing.Union[str, IResolvable] = None,
  framework_type: typing.Union[str, IResolvable] = None,
  inference_spec: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  labels: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, LabelsProperty]]] = None,
  metrics: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  options: typing.Union[str, IResolvable] = None,
  source_id: typing.Union[str, IResolvable] = None,
  source_type: typing.Union[str, IResolvable] = None,
  training_spec: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  version_description: typing.Union[str, IResolvable] = None,
  version_name: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

model_id^Required

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

Property modelId: Model ID.

For details about how to obtain the model ID.

uri^Required

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

Property uri: Model version URI, that is, the location where the model is stored.

Possible values are:

• The HTTP(S) address of the model, for example: 'https://myweb.com/mymodel.tar.gz '.
• If the model is stored in OSS, the format is 'oss://./object '. For the endpoint configuration, see Access domain name and data center. For example, see OSS:// mybucket/'.

approval_status^Optional

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

Property approvalStatus: Admission status, with values as follows: - Pending: to be determined.

• Approved: Allow to go online.
• Rejected: Online is not allowed.

extra_info^Optional

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

Property extraInfo: The additional information.

format_type^Optional

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

Property formatType: Model format, possible values: - OfflineModel - SavedModel - Keras H5 - Frozen Pb - Caffe Prototxt - TorchScript - XGBoost - PMML - AlinkModel - ONNX.

framework_type^Optional

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

Property frameworkType: Model framework, possible values: - Pytorch - XGBoost - Keras - Caffe - Alink - Xflow - TensorFlow.

inference_spec^Optional

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

Property inferenceSpec: Describes how to apply to downstream inference services.

For example, describe the processor and container of EAS. Example: { "processor": "tensorflow_gpu_1.12" }

labels^Optional

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

Property labels: List of model version labels.

metrics^Optional

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

Property metrics: The metrics for the model.

The length after serialization is limited to 8,192. Example: { "Results": [{ "Dataset": { "DatasetId": "d-sdkjanksaklerhfd" }, "Metrics": { "cer": 0.175 } }, { "Dataset": { "Uri": "oss://xxxx/" }, "Metrics": { "cer": 0.172 } }] }

options^Optional

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

Property options: The extended field.

This is a JSON string.

source_id^Optional

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

Property sourceId: Source ID.

• When the source type is Custom, this field is not restricted.

• When the source is PAIFlow or TrainingService, the format is: region=,workspaceId=,kind=,id= Among them:

• region is the Alibaba Cloud region ID.

• workspaceId indicates the workspace ID.
• kind: is a type. Value: PipelineRun(PAIFlow workflow);ServiceJob (training service).
• id: is a unique identifier.

source_type^Optional

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

Property sourceType: Model source type, possible values: - Custom: Custom.

• PAIFlow:PAI workflow.
• TrainingService:PAI training service.

training_spec^Optional

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

Property trainingSpec: Training configuration.

Configuration for fine-tuning, incremental training.

version_description^Optional

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

Property versionDescription: Model version description.

version_name^Optional

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

Property versionName: The model version, which is unique for each model.

If you leave this parameter empty, the first version is 0.1.0 by default. After that, the minor version number is increased by 1 in sequence. For example, the second version number is 0.2.0. A version number consists of a major version number, a minor version number, and a stage version number, separated by periods (.). The major version number and minor version number are numeric. The stage version number begins with a digit and can include numbers, underscores, and letters. For example, the version number is 1.1.0 or 2.3.4_beta.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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

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

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

is_construct

import ros_cdk_pai
ros_cdk_pai.ModelVersion.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

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_approval_status^Required

attr_approval_status: typing.Union[str, IResolvable]

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

Attribute ApprovalStatus: Admission status, with values as follows:.

attr_extra_info^Required

attr_extra_info: typing.Union[str, IResolvable]

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

Attribute ExtraInfo: Other information.

attr_format_type^Required

attr_format_type: typing.Union[str, IResolvable]

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

Attribute FormatType: Model format, possible values:.

attr_framework_type^Required

attr_framework_type: typing.Union[str, IResolvable]

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

Attribute FrameworkType: Model framework, possible values:.

attr_gmt_create_time^Required

attr_gmt_create_time: typing.Union[str, IResolvable]

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

Attribute GmtCreateTime: Create a model UTC time in the format ISO8601.

attr_gmt_modified_time^Required

attr_gmt_modified_time: typing.Union[str, IResolvable]

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

Attribute GmtModifiedTime: Finally, update the model UTC time in the format iso8601.

attr_inference_spec^Required

attr_inference_spec: typing.Union[str, IResolvable]

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

Attribute InferenceSpec: Describes how to apply to downstream inference services, such as processors and containers of EAS.

attr_labels^Required

attr_labels: typing.Union[str, IResolvable]

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

Attribute Labels: List of model version labels.

attr_metrics^Required

attr_metrics: typing.Union[str, IResolvable]

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

Attribute Metrics: Model indicators.

attr_options^Required

attr_options: typing.Union[str, IResolvable]

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

Attribute Options: Extension field.

The JsonString type.

attr_owner_id^Required

attr_owner_id: typing.Union[str, IResolvable]

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

Attribute OwnerId: The Alibaba Cloud account ID.

attr_source_id^Required

attr_source_id: typing.Union[str, IResolvable]

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

Attribute SourceId: Source ID.

attr_source_type^Required

attr_source_type: typing.Union[str, IResolvable]

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

Attribute SourceType: Model source type, possible values:.

attr_training_spec^Required

attr_training_spec: typing.Union[str, IResolvable]

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

Attribute TrainingSpec: Training configuration.

Configuration for fine-tuning, incremental training.

attr_uri^Required

attr_uri: typing.Union[str, IResolvable]

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

Attribute Uri: Model version URI, that is, the location where the model is stored.

attr_user_id^Required

attr_user_id: typing.Union[str, IResolvable]

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

Attribute UserId: The user ID.

attr_version_description^Required

attr_version_description: typing.Union[str, IResolvable]

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

Attribute VersionDescription: Model version description.

attr_version_name^Required

attr_version_name: typing.Union[str, IResolvable]

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

Attribute VersionName: Model version.

props^Required

props: ModelVersionProps

• Type: ModelVersionProps