Parameter Overview
You can use DatasetImportStep to create a dataset import phase. The following is an example of defining a DatasetImportStep.
Parameter |
Description |
Mandatory |
Data Type |
---|---|---|---|
name |
Name of a dataset import phase. The name contains a maximum of 64 characters, including only letters, digits, underscores (_), and hyphens (-). It must start with a letter and must be unique in a workflow. |
Yes |
str |
inputs |
Inputs of the dataset import phase. |
Yes |
DatasetImportInput or DatasetImportInput list |
outputs |
Outputs of the dataset import phase. |
Yes |
DatasetImportOutput or DatasetImportOutput list |
properties |
Configurations for dataset import. |
Yes |
ImportDataInfo |
title |
Title for frontend display. |
No |
str |
description |
Description of the dataset import phase. |
No |
str |
policy |
Phase execution policy. |
No |
StepPolicy |
depend_steps |
Dependency phases. |
No |
Step or step list |
Parameter |
Description |
Mandatory |
Data Type |
---|---|---|---|
name |
Input name of the dataset import phase. The name can contain a maximum of 64 characters, including only letters, digits, underscores (_), and hyphens (-), and must start with a letter. The input name of a step must be unique. |
Yes |
str |
data |
Input data object of the dataset import phase. |
Yes |
Dataset, OBS, or labeling job object. Currently, only Dataset, DatasetConsumption, DatasetPlaceholder, OBSPath, OBSConsumption, OBSPlaceholder, LabelTask, LabelTaskPlaceholder, LabelTaskConsumption, and DataConsumptionSelector are supported. |
Parameter |
Description |
Mandatory |
Data Type |
---|---|---|---|
name |
Output name of the dataset import phase. The name can contain a maximum of 64 characters, including only letters, digits, underscores (_), and hyphens (-), and must start with a letter. The output name of a step must be unique. |
Yes |
str |
Parameter |
Description |
Mandatory |
Data Type |
---|---|---|---|
annotation_format_config |
Configurations of the imported labeling format |
No |
AnnotationFormatConfig |
excluded_labels |
Samples with specified labels are not imported. |
No |
Label list |
import_annotated |
Whether to import the labeled samples in the original dataset to the To Be Confirmed tab. The default value is false, indicating that the labeled samples in the original dataset are not imported to the To Be Confirmed tab. Options:
|
No |
bool |
import_annotations |
Whether to import labels. Options:
|
No |
bool |
import_samples |
Whether to import samples. Options:
|
No |
bool |
import_type |
Import mode. Options:
|
No |
ImportTypeEnum |
included_labels |
Samples with specified labels are imported. |
No |
Label list |
label_format |
Label format. This parameter is used only for text datasets. |
No |
LabelFormat |
Parameter |
Description |
Mandatory |
Data Type |
---|---|---|---|
format_name |
Name of a labeling format |
No |
AnnotationFormatEnum |
parameters |
Advanced parameters of the labeling format |
No |
AnnotationFormatParameters |
scene |
Labeling scenario, which is optional |
No |
LabelTaskTypeEnum |
Parameter |
Description |
Mandatory |
Data Type |
---|---|---|---|
difficult_only |
Whether to import only hard examples. Options:
|
No |
bool |
included_labels |
Samples with specified labels are imported. |
No |
Label list |
label_separator |
Separator between labels. By default, the comma (,) is used as the separator. The separator needs to be escaped. The separator can contain only one character, which must be a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;, |
No |
str |
sample_label_separator |
Separator between the text and label. By default, the Tab key is used as the separator. The separator needs to be escaped. The separator can contain only one character, which must be a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;, |
No |
str |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot