ModelVersionProps

Properties for defining a ModelVersion.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-pai-modelversion

Initializer

import ros_cdk_pai
ros_cdk_pai.ModelVersionProps(
  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
)

Properties

model_id^Required

model_id: typing.Union[str, IResolvable]

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

Property modelId: Model ID.

For details about how to obtain the model ID.

uri^Required

uri: typing.Union[str, IResolvable]

• 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

approval_status: typing.Union[str, IResolvable]

• 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

extra_info: typing.Union[IResolvable, typing.Mapping[typing.Any]]

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

Property extraInfo: The additional information.

format_type^Optional

format_type: typing.Union[str, IResolvable]

• 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

framework_type: typing.Union[str, IResolvable]

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

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

inference_spec^Optional

inference_spec: typing.Union[IResolvable, typing.Mapping[typing.Any]]

• 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

labels: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, LabelsProperty]]]

• 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

metrics: typing.Union[IResolvable, typing.Mapping[typing.Any]]

• 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

options: typing.Union[str, IResolvable]

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

Property options: The extended field.

This is a JSON string.

source_id^Optional

source_id: typing.Union[str, IResolvable]

• 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

source_type: typing.Union[str, IResolvable]

• 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

training_spec: typing.Union[IResolvable, typing.Mapping[typing.Any]]

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

Property trainingSpec: Training configuration.

Configuration for fine-tuning, incremental training.

version_description^Optional

version_description: typing.Union[str, IResolvable]

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

Property versionDescription: Model version description.

version_name^Optional

version_name: typing.Union[str, IResolvable]

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