Dataset Resource

Definition

This is an object representing a collection of classes (concepts like identities or landmarks) that can be used as input to train a custom model for the Face Recognition or Landmark Recognition module.

ENDPOINTS

GET /v1/datasets/

GET /v1/datasets/{DATASET_ID}/

POST /v1/datasets/

PUT /v1/datasets/{DATASET_ID}/

DELETE /v1/datasets/{DATASET_ID}/

Attributes

Top level attributes

Name	Type	Description
id	string	Global identifier to access the actual resource
name	string	Name of the dataset
description	string	Description or notes of the dataset
type	string	The type of the dataset (See "Available dataset types")
time_created	string	Creation time of the dataset (ISO Time String)
time_updated	string	Modification time of the dataset (ISO Time String)
number_of_classes	number	Number of classes in this dataset collection.
number_of_active_classes	number	Number of classes that are enabled for training (active) in this dataset collection.
number_of_images	number	Number of images from all classes in this dataset collection.
number_of_active_images	number	Number of images that are enabled for training (active) from all classes in this dataset collection.
preview_images	list of strings	Preview images from the first three classes as DeepVA Storage URL
evaluation_result	dict	Evaluation result of the dataset. See "Child attributes of evaluation_result"

Child attributes of evaluation_result

Coming soon

Available dataset types

Type	Description
face	Dataset is of type "face" and can be only used to train a Face Recognition model. It should contain images of faces.
landmark	Dataset is of type "landmark" and can be only used to train a Landmark Recognition model. It should contain images of landmarks.

JSON Example

The following JSON snippet is showing a Dataset object.

{
   "id":"9538e44c-6f30-40b7-8d7c-73bda1d41a9e",
   "name":"My Demo",
   "description":"My demo dataset",
   "version":1.0,
   "type":"face",
   "time_created":"2020-01-23 09:34:31.422000",
   "time_updated":"2020-01-23 09:34:31.422000",
   "number_of_classes":17,
   "number_of_active_classes":17,
   "number_of_images":65,
   "number_of_active_images":65,
   "preview_images":[
      "storage://V4Ic75h6RYqKXK9TkkDw",
      "storage://t7r2deRbEW8SxZy3oHyX",
      "storage://IQuHT85doYr8jZOV3AkJ"
   ],
   "evaluation_result":{}
}