Skip to content

DatasetVersionProps

Properties for defining a DatasetVersion.

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

Initializer

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

Properties

Name Type Description
datasetId string | @alicloud/ros-cdk-core.IResolvable Property datasetId: The ID of the dataset.
dataSourceType string | @alicloud/ros-cdk-core.IResolvable Property dataSourceType: The data source type.
property string | @alicloud/ros-cdk-core.IResolvable Property property: The properties of the dataset.
uri string | @alicloud/ros-cdk-core.IResolvable Property uri: The Uri configuration sample is as follows: - The data source type is OSS:'oss:\/\/bucket.endpoint\/object' - The data source type is NAS: The general NAS format is: 'nas:\/\/.region\/subpath\/to\/dir\/'; CPFS1.0:'nas:\/\/.region\/subpath\/to\/dir \/'; CPFS2.0:'nas:\/\/.region\/\/'. CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-<8-bit ascii characters>;CPFS2.0 is cpfs-<16 ascii characters>.
dataCount number | @alicloud/ros-cdk-core.IResolvable Property dataCount: The number of dataset files, in units of pieces.
dataSize number | @alicloud/ros-cdk-core.IResolvable Property dataSize: The size of the dataset file in bytes.
description string | @alicloud/ros-cdk-core.IResolvable Property description: To create a custom description for dataset versions in order to distinguish between different versions of the dataset.
labels @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | LabelsProperty[] Property labels: Dataset version tag list.
options string | @alicloud/ros-cdk-core.IResolvable Property options: The extended field, which is of the JsonString type.
sourceId string | @alicloud/ros-cdk-core.IResolvable Property sourceId: The data source ID.
sourceType string | @alicloud/ros-cdk-core.IResolvable Property sourceType: The data source type.

datasetIdRequired

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

Property datasetId: The ID of the dataset.


dataSourceTypeRequired

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

Property dataSourceType: The data source type.

The following values are supported: - OSS: Alibaba Cloud Object Storage (OSS). - NAS: Alibaba cloud file storage (NAS). - CPFS


propertyRequired

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

Property property: The properties of the dataset.

The following values are supported: - FILE: FILE. - DIRECTORY: folder.


uriRequired

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

Property uri: The Uri configuration sample is as follows: - The data source type is OSS:'oss:\/\/bucket.endpoint\/object' - The data source type is NAS: The general NAS format is: 'nas:\/\/.region\/subpath\/to\/dir\/'; CPFS1.0:'nas:\/\/.region\/subpath\/to\/dir \/'; CPFS2.0:'nas:\/\/.region\/\/'. CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-<8-bit ascii characters>;CPFS2.0 is cpfs-<16 ascii characters>.


dataCountOptional

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

Property dataCount: The number of dataset files, in units of pieces.


dataSizeOptional

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

Property dataSize: The size of the dataset file in bytes.


descriptionOptional

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

Property description: To create a custom description for dataset versions in order to distinguish between different versions of the dataset.


labelsOptional

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

Property labels: Dataset version tag list.


optionsOptional

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

Property options: The extended field, which is of the JsonString type.

When DLC uses a dataset, you can specify the default Mount path for the dataset by configuring the mountPath field.


sourceIdOptional

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

Property sourceId: The data source ID.

When the SourceType is USER, SourceId can be customized. - When SourceType is ITAG, that is, when the iTAG module labels the data set generated by the result, SourceId is the task ID of ITAG. - When SourceType is PAI_PUBLIC_DATASET, that is, a dataset created using PAI public datasets, SourceId is empty by default.


sourceTypeOptional

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

Property sourceType: The data source type.

The default value is USER. The following values are supported: - PAI-PUBLIC-DATASET:PAI public dataset. - ITAG: The dataset generated by the iTAG module annotation result. - USER: The data set registered by the USER.