zeff.record package

Module contents

ZeffClient Record.

A record is a collection of information that will be used to train a machine, or on which the machine may make an inferance. The information is contained in sets of strutured and unstructured data.

Structured data is dictionary of key-value items where the value has either a continuous type (e.g. integer or floating point) or a discrete type. This data may be marked to use for training, for inference, or to be ignored by the machine.

Unstructured data is a stream of data that has media-type (e.g. image/jpeg or video/mpeg) and an optional tag that will group it with other unstructured data.

@startuml

namespace ZeffClient.genericrecord {
	class Record {
		name: String
		void validate()
		void submit()
	}
	Record "1" *-- "0..*" StructuredData
	Record "1" *-- "0..*" UnstructuredData

	class StructuredData {
		name: String
		value: String, Int, Float, Bool
		data_type: [continuous, discrete]
		target: [yes, no, ignore]
	}

	class UnstructuredData{
		data: URI
		file_type: [image, video, audio, document, text, meta]
		group_by: String
		embeddata: Bool
	}
}

@enduml

Classes

Record

This represents a single record in Zeff.

property name

The unique name for the record.

property structured_data

List of StructuredData objects that belong to this record. This list should not be modified directly; setting StructuredData.record property will add the object to the list.

property unstructured_data

List of UnstructuredData objects that belong to this record. This list should not be modified directly; setting UnstructuredData.record property will add the object to the list.

StructuredData

Single item of structured data in a record.

A structured data is a mapping of name to value with additional information about the value.

property name

The unique key that identifies this data item.

property value

The value stored in this data item.

property target

How a data item is to be used in training or inference. This property is ignored by temporal records (TemporalRecord), and will not be sent to the Cloud API.

property data_type

Is the data continuous or discrete.

property record

The record for this data item. Setting this property will add this item to Record.structured_data list automatically.

zeff.record.StructuredData.record

Record that contains this structured data item.

UnstructuredData

Single item of unstructured data in a record.

An unstructured data is a URI to data that has an associated file type and may be grouped with other similar data.

property data_uri

URI to the raw data.

property file_type

The file type of the data.

property group_by

Name of group this item should be associated with.

property upload

Indicates that the data should be uploaded to the Zeff API when this data item is uploaded (default is for the server to access the data directly using the URL in data).

property accessible

Flag set during validation that the location given by data_uri is accessible.

property record

The record for this data item. Setting this property will add this item to Record.unstructured_data list automatically.

zeff.record.UnstructuredData.record

Record that contains this unstructured data item.