Updated on 2024-05-30 GMT+08:00

Obtaining Dataset Statistics

Function

Obtain dataset statistics.

Debugging

You can debug this API in API Explorer which supports automatic authentication. API Explorer can automatically generate SDK code examples and provide the SDK code example debugging.

URI

GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/stats

Table 1 URI parameters

Parameter

Mandatory

Type

Description

dataset_id

Yes

String

Dataset ID

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID and Name.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

email

No

String

Email address of a labeling team member

locale

No

String

Language . Options:

  • zh-cn: Chinese
  • en-us: English (default value)

sample_state

No

String

Statistics on the specified sample state. Options:

  • __ALL__: labeled

  • __NONE__: unlabeled

  • __UNCHECK__: to be accepted

  • __ACCEPTED__: accepted

  • __REJECTED__: rejected

  • __UNREVIEWED__: to be reviewed

  • __REVIEWED__: reviewed

  • __WORKFORCE_SAMPLED__: sampled

  • __WORKFORCE_SAMPLED_UNCHECK__: sampling pending check

  • __WORKFORCE_SAMPLED_CHECKED__: sampling checked

  • __WORKFORCE_SAMPLED_ACCEPTED__: sampling accepted

  • __WORKFORCE_SAMPLED_REJECTED__: sampling rejected

  • __AUTO_ANNOTATION__: to be confirmed

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

data_path

String

Path for storing data of a dataset

data_spliting_enable

Boolean

Whether the dataset can be split into training set and validation set based on the sample labeling statistics. Options:

  • true: The dataset can be split into training and validation sets.

  • false: The dataset cannot be split into training and validation sets.

grouped_label_stats

Map<String,Array<LabelStats>>

Label statistics grouped by labeling type

hard_detail_stats

Map<String,PairOfintAndHardDetail>

Statistics on hard example reasons. The type is Map<Integer, Pair<Integer, HardDetail>>. The key of Map indicates the ID of the hard example reason, the key of Pair indicates how many times has the hard example reason occurred, and the value of Pair indicates the hard example reason.

key_sample_stats

Map<String,Integer>

Statistics on hard examples

label_stats

Array of LabelStats objects

List of label statistics

metadata_stats

Map<String,Object>

Statistics on sample metadata in JSON format.

sample_stats

Map<String,Integer>

Statistics on sample status

Table 4 LabelStats

Parameter

Type

Description

attributes

Array of LabelAttribute objects

Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.

count

Integer

Number of labels

name

String

Label name

property

LabelProperty object

Basic attribute key-value pair of a label, such as color and shortcut keys.

sample_count

Integer

Number of samples containing the label

type

Integer

Label type. Options:

  • 0: image classification

  • 1: object detection

  • 3: image segmentation

  • 100: text classification

  • 101: named entity recognition

  • 102: text triplet relationship

  • 103: text triplet entity

  • 200: sound classification

  • 201: speech content

  • 202: speech paragraph labeling

  • 600: video labeling

Table 5 PairOfintAndHardDetail

Parameter

Type

Description

key

Integer

Number of times that a hard example reason occurs

value

HardDetail object

Reason for a hard example

Table 6 HardDetail

Parameter

Type

Description

alo_name

String

Alias

id

Integer

Reason ID

reason

String

Reason description

suggestion

String

Handling suggestion

Table 7 LabelAttribute

Parameter

Type

Description

default_value

String

Default value of a label attribute

id

String

Label attribute ID, which can be obtained in the label list.

name

String

Label attribute name, which can contain a maximum of 64 characters. Special characters (!<>=&"') cannot be included.

type

String

Label attribute type. Options:

  • text: Select a text label.

  • select: Select from the drop-down list.

values

Array of LabelAttributeValue objects

List of label attribute values

Table 8 LabelAttributeValue

Parameter

Type

Description

id

String

Label attribute value ID

value

String

Label attribute value

Table 9 LabelProperty

Parameter

Type

Description

@modelarts:color

String

Label color, which is a hexadecimal code of a color, for example, #FFFFF0. The default value is left blank.

@modelarts:default_shape

String

Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. Options:

  • bndbox: rectangle

  • polygon: polygon

  • circle: circle

  • line: straight line

  • dashed: dashed line

  • point: point

  • polyline: polyline

@modelarts:from_type

String

Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

@modelarts:rename_to

String

The new name of the label

@modelarts:shortcut

String

Label shortcut key, for example, D. By default, this parameter is left blank.

@modelarts:to_type

String

Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

Request Example

Run the following command to obtain dataset statistics:

GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/stats

Response Example

Status code: 200

OK

{
  "label_stats" : [ {
    "name" : "Bees",
    "type" : 1,
    "property" : {
      "@modelarts:color" : "#3399ff"
    },
    "count" : 8,
    "sample_count" : 5
  } ],
  "sample_stats" : {
    "un_annotation" : 309,
    "all" : 317,
    "total" : 317,
    "deleted" : 0,
    "manual_annotation" : 8,
    "auto_annotation" : 0,
    "lefted" : 317
  },
  "key_sample_stats" : {
    "total" : 317,
    "non_key_sample" : 315,
    "key_sample" : 2
  },
  "metadata_stats" : { },
  "data_spliting_enable" : false
}

Status Code

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

Error Code

For details, see Error Codes.