​
Classes

​
DataAcquisition

edgeimpulse.data.sample_type.DataAcquisition(
	protected: edgeimpulse.data.sample_type.Protected,
	payload: edgeimpulse.data.sample_type.Payload,
	signature: str | None = None
)
Wrapper class for the Edge Impulse data acquisition format. See here for more information: https://docs.edgeimpulse.com/reference/data-acquisition-format.
Parameters
protectededgeimpulse.data.sample_type.Protected
payloadedgeimpulse.data.sample_type.Payload
signaturestr | None = None
Instance variables
payloadedgeimpulse.data.sample_type.Payload
protectededgeimpulse.data.sample_type.Protected
signaturestr | None

​
Payload

edgeimpulse.data.sample_type.Payload(
	device_type: str,
	sensors: List[edgeimpulse.data.sample_type.Sensor],
	values: List[List[float]],
	interval_ms: int | None = 0,
	device_name: str | None = None
)
Wrapper class for the sensor data. Information about the data acquisition format can be found here: https://docs.edgeimpulse.com/reference/data-acquisition-format.
Parameters
device_typestr
sensorsList[edgeimpulse.data.sample_type.Sensor]
valuesList[List[float]]
interval_msint | None = 0
device_namestr | None = None
Instance variables
device_namestr | None
device_typestr
interval_msint | None
sensorsList[edgeimpulse.data.sample_type.Sensor]
valuesList[List[float]]

​
Protected

edgeimpulse.data.sample_type.Protected(
	ver: str = 'v1',
	alg: Literal['HS256', 'none'] = 'none',
	iat: int | None = None
)
Wrapper class for information about the signature format. More information can be found here: https://docs.edgeimpulse.com/reference/data-acquisition-format.
Parameters
verstr = 'v1'
algLiteral['HS256', 'none'] = 'none'
iatint | None = None
Instance variables
algLiteral['HS256', 'none']
iatint | None
verstr

​
Sample

edgeimpulse.data.sample_type.Sample(
	data: io.BufferedIOBase | _io.StringIO | str,
	filename: str | None = None,
	category: Literal['training', 'testing', 'anomaly', 'split'] | None = 'split',
	label: str | None = None,
	bounding_boxes: List[dict] | None = None,
	metadata: dict | None = None,
	sample_id: int | None = None,
	structured_labels: List[dict] | None = None
)
Wrapper class for sample data, labels, and associated metadata. Sample data should be contained in a file or file-like object, for example, as the return from open(..., "rb"). The upload_samples() function expects Sample objects as input.
Parameters
dataio.BufferedIOBase | _io.StringIO | str
filenamestr | None = None
categoryLiteral['training', 'testing', 'anomaly', 'split'] | None = 'split'
labelstr | None = None
bounding_boxesList[dict] | None = None
metadatadict | None = None
sample_idint | None = None
structured_labelsList[dict] | None = None
Instance variables
bounding_boxesList[dict] | None
categoryLiteral['training', 'testing', 'anomaly', 'split'] | None
dataio.BufferedIOBase | _io.StringIO | str
filenamestr | None
labelstr | None
metadatadict | None
sample_idint | None
structured_labelsList[dict] | None

​
SampleInfo

edgeimpulse.data.sample_type.SampleInfo(
	sample_id: int | None = None,
	filename: str | None = None,
	category: str | None = None,
	label: str | None = None
)
Wrapper for the response from the Edge Impulse ingestion service when retrieving sample information.
Parameters
sample_idint | None = None
filenamestr | None = None
categorystr | None = None
labelstr | None = None
Instance variables
categorystr | None
filenamestr | None
labelstr | None
sample_idint | None

​
SampleIngestionResponse

edgeimpulse.data.sample_type.SampleIngestionResponse(
	sample: edgeimpulse.data.sample_type.Sample,
	response: dict
)
Wrapper for the response from the Edge Impulse ingestion service when uploading a sample along with the sample that was uploaded.
Parameters
sampleedgeimpulse.data.sample_type.Sample
responsedict

​
Sensor

edgeimpulse.data.sample_type.Sensor(
	name: str,
	units: Literal['m', 'kg', 'g', 's', 'A', 'K', 'cd', 'mol', 'Hz', 'rad', 'sr', 'N', 'Pa', 'J', 'W', 'C', 'V', 'F', 'Ohm', 'S', 'Wb', 'T', 'H', 'Cel', 'lm', 'lx', 'Bq', 'Gy', 'Sv', 'kat', 'm2', 'm3', 'l', 'm/s', 'm/s2', 'm3/s', 'l/s', 'W/m2', 'cd/m2', 'bit', 'bit/s', 'lat', 'lon', 'pH', 'dB', 'dBW', 'Bspl', 'count', '/', '%', '%RH', '%EL', 'EL', '1/s', '1/min', 'beat/min', 'beats', 'S/m', 'B', 'VA', 'VAs', 'var', 'vars', 'J/m', 'kg/m3', 'deg', 'NTU', 'rgba'] = 'm/s'
)
Represents a sensor in the Edge Impulse data acquisition format. Note: The units must comply with the SenML units list: https://www.iana.org/assignments/senml/senml.xhtml
Parameters
namestr
unitsLiteral['m', 'kg', 'g', 's', 'A', 'K', 'cd', 'mol', 'Hz', 'rad', 'sr', 'N', 'Pa', 'J', 'W', 'C', 'V', 'F', 'Ohm', 'S', 'Wb', 'T', 'H', 'Cel', 'lm', 'lx', 'Bq', 'Gy', 'Sv', 'kat', 'm2', 'm3', 'l', 'm/s', 'm/s2', 'm3/s', 'l/s', 'W/m2', 'cd/m2', 'bit', 'bit/s', 'lat', 'lon', 'pH', 'dB', 'dBW', 'Bspl', 'count', '/', '%', '%RH', '%EL', 'EL', '1/s', '1/min', 'beat/min', 'beats', 'S/m', 'B', 'VA', 'VAs', 'var', 'vars', 'J/m', 'kg/m3', 'deg', 'NTU', 'rgba'] = 'm/s'
Instance variables
namestr
unitsLiteral['m', 'kg', 'g', 's', 'A', 'K', 'cd', 'mol', 'Hz', 'rad', 'sr', 'N', 'Pa', 'J', 'W', 'C', 'V', 'F', 'Ohm', 'S', 'Wb', 'T', 'H', 'Cel', 'lm', 'lx', 'Bq', 'Gy', 'Sv', 'kat', 'm2', 'm3', 'l', 'm/s', 'm/s2', 'm3/s', 'l/s', 'W/m2', 'cd/m2', 'bit', 'bit/s', 'lat', 'lon', 'pH', 'dB', 'dBW', 'Bspl', 'count', '/', '%', '%RH', '%EL', 'EL', '1/s', '1/min', 'beat/min', 'beats', 'S/m', 'B', 'VA', 'VAs', 'var', 'vars', 'J/m', 'kg/m3', 'deg', 'NTU', 'rgba']

​
UploadSamplesResponse

edgeimpulse.data.sample_type.UploadSamplesResponse(
	successes: List[edgeimpulse.data.sample_type.SampleIngestionResponse],
	fails: List[edgeimpulse.data.sample_type.SampleIngestionResponse]
)
Response from the Edge Impulse server when uploading multiple samples.
Parameters
successesList[edgeimpulse.data.sample_type.SampleIngestionResponse]
failsList[edgeimpulse.data.sample_type.SampleIngestionResponse]
METHODS

​
extend

edgeimpulse.data.sample_type.UploadSamplesResponse.extend(
	self,
	successes: List[edgeimpulse.data.sample_type.SampleIngestionResponse],
	fails: List[edgeimpulse.data.sample_type.SampleIngestionResponse]
)
Add new responses to the existing responses.
Parameters
self
successesList[edgeimpulse.data.sample_type.SampleIngestionResponse]
failsList[edgeimpulse.data.sample_type.SampleIngestionResponse]