DatasetProps
Properties for defining a Dataset.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-pai-dataset
Initializer
import ros_cdk_pai
ros_cdk_pai.DatasetProps(
dataset_name: typing.Union[str, IResolvable],
data_source_type: typing.Union[str, IResolvable],
property: typing.Union[str, IResolvable],
uri: typing.Union[str, IResolvable],
workspace_id: typing.Union[str, IResolvable],
accessibility: typing.Union[str, IResolvable] = None,
data_type: typing.Union[str, IResolvable] = None,
description: typing.Union[str, IResolvable] = None,
options: typing.Union[str, IResolvable] = None,
source_id: typing.Union[str, IResolvable] = None,
source_type: typing.Union[str, IResolvable] = None
)
Properties
| Name | Type | Description |
|---|---|---|
dataset_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property datasetName: The name of the dataset. |
data_source_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property dataSourceType: The data source type. |
property |
typing.Union[str, ros_cdk_core.IResolvable] |
Property property: The properties of the dataset. |
uri |
typing.Union[str, 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:\/\/ |
workspace_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property workspaceId: The ID of the workspace where the dataset is located. |
accessibility |
typing.Union[str, ros_cdk_core.IResolvable] |
Property accessibility: Workspace visibility. |
data_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property dataType: The dataset type. |
description |
typing.Union[str, ros_cdk_core.IResolvable] |
Property description: Custom descriptions of datasets to distinguish between different datasets. |
options |
typing.Union[str, ros_cdk_core.IResolvable] |
Property options: The extended field, which is of the JsonString type. |
source_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property sourceId: The data source ID. |
source_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property sourceType: The data source type. |
dataset_nameRequired
dataset_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property datasetName: The name of the dataset.
The naming rules are as follows:
- Start with a lowercase letter, uppercase letter, number, or Chinese.
- Can contain an underscore (_) or a dash (-).
- 1~127 characters in length.
data_source_typeRequired
data_source_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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).
propertyRequired
property: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property property: The properties of the dataset.
The following values are supported:
- FILE: FILE.
- DIRECTORY: folder.
uriRequired
uri: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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:\/\/
workspace_idRequired
workspace_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property workspaceId: The ID of the workspace where the dataset is located.
For details about how to obtain the workspace ID, see ListWorkspaces. If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.
accessibilityOptional
accessibility: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property accessibility: Workspace visibility.
The following values are supported:
- PRIVATE (default): indicates that the workspace is visible to itself and the administrator.
- PUBLIC: The workspace is visible to all users.
data_typeOptional
data_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dataType: The dataset type.
The default value is COMMON. The following values are supported:
- COMMON: COMMON.
- PIC: picture.
- TEXT: TEXT.
- VIDEO: VIDEO.
- AUDIO: AUDIO.
descriptionOptional
description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: Custom descriptions of datasets to distinguish between different datasets.
optionsOptional
options: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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.
source_idOptional
source_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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.
source_typeOptional
source_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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.