Skip to content

ModelVersionProps

Properties for defining a ModelVersion.

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

Initializer

import com.aliyun.ros.cdk.pai.ModelVersionProps;
ModelVersionProps.builder()
    .modelId(java.lang.String)
    .modelId(IResolvable)
    .uri(java.lang.String)
    .uri(IResolvable)
//  .approvalStatus(java.lang.String)
//  .approvalStatus(IResolvable)
//  .extraInfo(IResolvable)
//  .extraInfo(java.util.Map<java.lang.String, java.lang.Object>)
//  .formatType(java.lang.String)
//  .formatType(IResolvable)
//  .frameworkType(java.lang.String)
//  .frameworkType(IResolvable)
//  .inferenceSpec(IResolvable)
//  .inferenceSpec(java.util.Map<java.lang.String, java.lang.Object>)
//  .labels(IResolvable)
//  .labels(java.util.List<IResolvable)
//  .labels(LabelsProperty>)
//  .metrics(IResolvable)
//  .metrics(java.util.Map<java.lang.String, java.lang.Object>)
//  .options(java.lang.String)
//  .options(IResolvable)
//  .sourceId(java.lang.String)
//  .sourceId(IResolvable)
//  .sourceType(java.lang.String)
//  .sourceType(IResolvable)
//  .trainingSpec(IResolvable)
//  .trainingSpec(java.util.Map<java.lang.String, java.lang.Object>)
//  .versionDescription(java.lang.String)
//  .versionDescription(IResolvable)
//  .versionName(java.lang.String)
//  .versionName(IResolvable)
    .build();

Properties

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

modelIdRequired

public java.lang.Object getModelId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property modelId: Model ID.

For details about how to obtain the model ID.


uriRequired

public java.lang.Object getUri();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getApprovalStatus();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getExtraInfo();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property extraInfo: The additional information.


formatTypeOptional

public java.lang.Object getFormatType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getFrameworkType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


inferenceSpecOptional

public java.lang.Object getInferenceSpec();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

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 java.lang.Object getLabels();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListLabelsProperty>

Property labels: List of model version labels.


metricsOptional

public java.lang.Object getMetrics();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

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 java.lang.Object getOptions();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property options: The extended field.

This is a JSON string.


sourceIdOptional

public java.lang.Object getSourceId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSourceType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

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

trainingSpecOptional

public java.lang.Object getTrainingSpec();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property trainingSpec: Training configuration.

Configuration for fine-tuning, incremental training.


versionDescriptionOptional

public java.lang.Object getVersionDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property versionDescription: Model version description.


versionNameOptional

public java.lang.Object getVersionName();
  • Type: java.lang.String OR com.aliyun.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.