Skip to content

ModelVersionProps

Properties for defining a ModelVersion.

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

Initializer

import { ModelVersionProps } from '@alicloud/ros-cdk-pai'
const modelVersionProps: ModelVersionProps = { ... }

Properties

Name Type Description
modelId string | @alicloud/ros-cdk-core.IResolvable Property modelId: Model ID.
uri string | @alicloud/ros-cdk-core.IResolvable Property uri: Model version URI, that is, the location where the model is stored.
approvalStatus string | @alicloud/ros-cdk-core.IResolvable Property approvalStatus: Admission status, with values as follows: - Pending: to be determined.
extraInfo @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property extraInfo: The additional information.
formatType string | @alicloud/ros-cdk-core.IResolvable Property formatType: Model format, possible values: - OfflineModel - SavedModel - Keras H5 - Frozen Pb - Caffe Prototxt - TorchScript - XGBoost - PMML - AlinkModel - ONNX.
frameworkType string | @alicloud/ros-cdk-core.IResolvable Property frameworkType: Model framework, possible values: - Pytorch - XGBoost - Keras - Caffe - Alink - Xflow - TensorFlow.
inferenceSpec @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property inferenceSpec: Describes how to apply to downstream inference services.
labels @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | LabelsProperty[] Property labels: List of model version labels.
metrics @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property metrics: The metrics for the model.
options string | @alicloud/ros-cdk-core.IResolvable Property options: The extended field.
sourceId string | @alicloud/ros-cdk-core.IResolvable Property sourceId: Source ID.
sourceType string | @alicloud/ros-cdk-core.IResolvable Property sourceType: Model source type, possible values: - Custom: Custom.
trainingSpec @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property trainingSpec: Training configuration.
versionDescription string | @alicloud/ros-cdk-core.IResolvable Property versionDescription: Model version description.
versionName string | @alicloud/ros-cdk-core.IResolvable Property versionName: The model version, which is unique for each model.

modelIdRequired

public readonly modelId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property modelId: Model ID.

For details about how to obtain the model ID.


uriRequired

public readonly uri: string | IResolvable;
  • Type: string | @alicloud/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\/'.


approvalStatusOptional

public readonly approvalStatus: string | IResolvable;
  • Type: string | @alicloud/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.


extraInfoOptional

public readonly extraInfo: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property extraInfo: The additional information.


formatTypeOptional

public readonly formatType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


frameworkTypeOptional

public readonly frameworkType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


inferenceSpecOptional

public readonly inferenceSpec: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: 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" }


labelsOptional

public readonly labels: IResolvable | IResolvable | LabelsProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | LabelsProperty[]

Property labels: List of model version labels.


metricsOptional

public readonly metrics: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: 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 } }] }


optionsOptional

public readonly options: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property options: The extended field.

This is a JSON string.


sourceIdOptional

public readonly sourceId: string | IResolvable;
  • Type: string | @alicloud/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.

sourceTypeOptional

public readonly sourceType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

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


trainingSpecOptional

public readonly trainingSpec: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property trainingSpec: Training configuration.

Configuration for fine-tuning, incremental training.


versionDescriptionOptional

public readonly versionDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property versionDescription: Model version description.


versionNameOptional

public readonly versionName: string | IResolvable;
  • Type: string | @alicloud/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.