download_dataset

Download and extract a dataset from the Edge Impulse CDN for tutorials, and quick prototyping.

Saves the dataset in the datasets/<name> folder. Use list_datasets to show available datasets for download.

Parameters

• name: str

• force_redownload: bool = False

• overwrite_existing: bool = False

• show_progress: bool = False

list_datasets

List the available datasets on the Edge Impulse CDN.

Return

List[dict]

load_timeseries

Load the timeseries dataset.

EdgeImpulseException

Common base class for all non-exit exceptions.

Parameters

• message

Bases

• builtins.Exception

• builtins.BaseException

Subclasses

• edgeimpulse.exceptions.InvalidAuthTypeException

• edgeimpulse.exceptions.InvalidDeployParameterException

• edgeimpulse.exceptions.InvalidDeviceException

• edgeimpulse.exceptions.InvalidEngineException

• edgeimpulse.exceptions.InvalidModelException

• edgeimpulse.exceptions.InvalidTargetException

• edgeimpulse.exceptions.MissingApiIngestionEndpointException

• edgeimpulse.exceptions.MissingApiKeyException

• edgeimpulse.exceptions.TimeoutException

• edgeimpulse.exceptions.UnsuccessfulRequestException

• edgeimpulse.exceptions.UnsupportedSampleType

InvalidAuthTypeException

Common base class for all non-exit exceptions.

Parameters

• message

Bases

• edgeimpulse.exceptions.EdgeImpulseException

• builtins.Exception

• builtins.BaseException

InvalidDeployParameterException

Exception raised when an invalid parameter is passed.

Parameters

• msg: str

Bases

• edgeimpulse.exceptions.EdgeImpulseException

• builtins.Exception

• builtins.BaseException

InvalidDeviceException

Exception raised when an invalid device is passed.

Parameters

• device: str

• profile_devices: List[str]

Bases

• edgeimpulse.exceptions.EdgeImpulseException

• builtins.Exception

• builtins.BaseException

InvalidEngineException

Exception raised when an invalid engine is passed.

For a list of valid engines use edgeimpulse.model.list_engines().

Parameters

• validation_error

Bases

• edgeimpulse.exceptions.EdgeImpulseException

• builtins.Exception

• builtins.BaseException

InvalidModelException

Common base class for all non-exit exceptions.

Parameters

• msg: str

Bases

• edgeimpulse.exceptions.EdgeImpulseException

• builtins.Exception

• builtins.BaseException

InvalidTargetException

Exception raised when an invalid target is passed.

For a list of valid targets use edgeimpulse.model.list_deployment_targets().

Parameters

• deploy_target: str

• target_names: List[str]

Bases

• edgeimpulse.exceptions.EdgeImpulseException

• builtins.Exception

• builtins.BaseException

MissingApiIngestionEndpointException

Common base class for all non-exit exceptions.

Bases

• edgeimpulse.exceptions.EdgeImpulseException

• builtins.Exception

• builtins.BaseException

MissingApiKeyException

Common base class for all non-exit exceptions.

Bases

• edgeimpulse.exceptions.EdgeImpulseException

• builtins.Exception

• builtins.BaseException

TimeoutException

Exception raised when a timeout has been reached.

Parameters

• msg: str

Bases

• edgeimpulse.exceptions.EdgeImpulseException

• builtins.Exception

• builtins.BaseException

UnsuccessfulRequestException

Common base class for all non-exit exceptions.

Parameters

• error: Optional[str]

Bases

• edgeimpulse.exceptions.EdgeImpulseException

• builtins.Exception

• builtins.BaseException

UnsupportedSampleType

Exception raised when attempting to upload or download a data type that is not supported by Edge Impulse.

Parameters

• error: Optional[str]

Bases

• edgeimpulse.exceptions.EdgeImpulseException

• builtins.Exception

• builtins.BaseException

Submodules

• edgeimpulse.experimental.api

• edgeimpulse.experimental.data

• edgeimpulse.experimental.impulse

• edgeimpulse.experimental.tuner

• edgeimpulse.experimental.util

EdgeImpulseApi

class edgeimpulse.experimental.EdgeImpulseApi(
		host: Optional[str] = None,
		key: Optional[str] = None,
		key_type: str = 'api'
)

Initialize the Edge Impulse Api.

Parameters

• host: Optional[str] = None

• key: Optional[str] = None

• key_type: str = 'api'

Instance variables

• classify: edgeimpulse_api.api.classify_api.ClassifyApi Classify samples in your project.

• client: edgeimpulse_api.api_client.ApiClient The client used for initializing the apis, use set_client to update the client.

• deployment: edgeimpulse_api.api.deployment_api.DeploymentApi Work with your model deployment targets.

• devices: edgeimpulse_api.api.devices_api.DevicesApi Work with devices in your project.

• dsp: edgeimpulse_api.api.dsp_api.DSPApi Work with (DSP) digital signal processing and feature extraction blocks in your project.

• export: edgeimpulse_api.api.export_api.ExportApi Export your project.

• host: Optional[str] Edge Impulse studio host (defaults to production).

• impulse: edgeimpulse_api.api.impulse_api.ImpulseApi Work and manage your Impulse (on-device feature extraction and classification pipeline).

• jobs: edgeimpulse_api.api.jobs_api.JobsApi Start and manage long running jobs.

• learn: edgeimpulse_api.api.learn_api.LearnApi Work with keras and pretrained models.

• login: edgeimpulse_api.api.login_api.LoginApi Login and authenticate.

• optimization: edgeimpulse_api.api.optimization_api.OptimizationApi Optimize and find a better model with the EON tuner.

• organization_blocks: edgeimpulse_api.api.organization_blocks_api.OrganizationBlocksApi Work with organization blocks.

• organization_create_project: edgeimpulse_api.api.organization_create_project_api.OrganizationCreateProjectApi Automate project creation for organizations.

• organization_data: edgeimpulse_api.api.organization_data_api.OrganizationDataApi Work with organization data.

• organization_data_campaigns: edgeimpulse_api.api.organization_data_campaigns_api.OrganizationDataCampaignsApi Work with organization data campaigns.

• organization_jobs: edgeimpulse_api.api.organization_jobs_api.OrganizationJobsApi Start and manage organization jobs.

• organization_pipelines: edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi Work with organization pipelines.

• organization_portals: edgeimpulse_api.api.organization_portals_api.OrganizationPortalsApi Create and manage organization portals.

• organizations: edgeimpulse_api.api.organizations_api.OrganizationsApi Work with your organizations.

• performance_calibration: edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi Calibrate your model performance with real world data.

• projects: edgeimpulse_api.api.projects_api.ProjectsApi Create and manage your projects.

• raw_data: edgeimpulse_api.api.raw_data_api.RawDataApi Work with your project data.

• upload_portal: edgeimpulse_api.api.upload_portal_api.UploadPortalApi Create and manage data upload portals.

• user: edgeimpulse_api.api.user_api.UserApi Manage user activation, creation and updates.

Methods

authenticate

edgeimpulse.experimental.authenticate(
		self,
		key: str,
		key_type: str = 'api',
		host: Optional[str] = None
) ‑> None

Authenticate against Edge Impulse.

Parameters

• self

• key: str

• key_type: str = 'api'

• host: Optional[str] = None

Return

None

default_project_id

edgeimpulse.experimental.default_project_id(
		self
) ‑> int

Get the default project ID from the provided API key.

Returns: int: The project associated with the api key.

Parameters

• self

Return

int

run_organization_job_until_completion

edgeimpulse.experimental.run_organization_job_until_completion(
		self,
		organization_id: int,
		job_id: int,
		data_cb=None,
		client=None,
		timeout_sec: Optional[int] = None
) ‑> None

Runs an organization job until completion.

Parameters

• self

• organization_id: int

• job_id: int

• data_cb=None

• client=None

• timeout_sec: Optional[int] = None

Return

None

run_project_job_until_completion

edgeimpulse.experimental.run_project_job_until_completion(
		self,
		job_id: int,
		data_cb=None,
		client=None,
		project_id: Optional[int] = None,
		timeout_sec: Optional[int] = None
) ‑> None

Runs a project job until completion.

Parameters

• self

• job_id: int

• data_cb=None

• client=None

• project_id: Optional[int] = None

• timeout_sec: Optional[int] = None

Return

None

set_client

edgeimpulse.experimental.set_client(
		self,
		client: edgeimpulse_api.api_client.ApiClient
) ‑> None

Set the API client and initialize the APIs wit that client.

Parameters

• self

• client: edgeimpulse_api.api_client.ApiClient

Return

None

DataAcquisition

class edgeimpulse.data.sample_type.DataAcquisition(
		protected: edgeimpulse.data.sample_type.Protected,
		payload: edgeimpulse.data.sample_type.Payload,
		signature: Optional[str] = None
)

Wrapper class for the Edge Impulse data acquisition format.

See here for more information: https://docs.edgeimpulse.com/reference/data-acquisition-format.

Parameters

• protected: edgeimpulse.data.sample_type.Protected

• payload: edgeimpulse.data.sample_type.Payload

• signature: Optional[str] = None

Class variables

• payload: edgeimpulse.data.sample_type.Payload

• protected: edgeimpulse.data.sample_type.Protected

• signature: Optional[str]

Payload

class edgeimpulse.data.sample_type.Payload(
		device_type: str,
		sensors: List[edgeimpulse.data.sample_type.Sensor],
		values: List[List[float]],
		interval_ms: Optional[int] = 0,
		device_name: Optional[str] = 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_type: str

• sensors: List[edgeimpulse.data.sample_type.Sensor]

• values: List[List[float]]

• interval_ms: Optional[int] = 0

• device_name: Optional[str] = None

Class variables

• device_name: Optional[str]

• device_type: str

• interval_ms: Optional[int]

• sensors: List[edgeimpulse.data.sample_type.Sensor]

• values: List[List[float]]

Protected

class edgeimpulse.data.sample_type.Protected(
		ver: str = 'v1',
		alg: Literal['HS256', 'none'] = 'none',
		iat: Optional[int] = None
)

Wrapper class for information about the signature format.

More information can be found here: https://docs.edgeimpulse.com/reference/data-acquisition-format.

Parameters

• ver: str = 'v1'

• alg: Literal['HS256', 'none'] = 'none'

• iat: Optional[int] = None

Class variables

• alg: Literal['HS256', 'none']

• iat: Optional[int]

• ver: str

Sample

class edgeimpulse.data.sample_type.Sample(
		data: Union[io.BufferedIOBase, _io.StringIO, str],
		filename: Optional[str] = None,
		category: Optional[Literal['training', 'testing', 'anomaly', 'split']] = 'split',
		label: Optional[str] = None,
		bounding_boxes: Optional[List[dict]] = None,
		metadata: Optional[dict] = None,
		sample_id: Optional[int] = None,
		structured_labels: Optional[List[dict]] = 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

• data: Union[io.BufferedIOBase, _io.StringIO, str]

• filename: Optional[str] = None

• category: Optional[Literal['training', 'testing', 'anomaly', 'split']] = 'split'

• label: Optional[str] = None

• bounding_boxes: Optional[List[dict]] = None

• metadata: Optional[dict] = None

• sample_id: Optional[int] = None

• structured_labels: Optional[List[dict]] = None

Class variables

• bounding_boxes: Optional[List[dict]]

• category: Optional[Literal['training', 'testing', 'anomaly', 'split']]

• data: Union[io.BufferedIOBase, _io.StringIO, str]

• filename: Optional[str]

• label: Optional[str]

• metadata: Optional[dict]

• sample_id: Optional[int]

• structured_labels: Optional[List[dict]]

SampleInfo

class edgeimpulse.data.sample_type.SampleInfo(
		sample_id: Optional[int] = None,
		filename: Optional[str] = None,
		category: Optional[str] = None,
		label: Optional[str] = None
)

Wrapper for the response from the Edge Impulse ingestion service when retrieving sample information.

Parameters

• sample_id: Optional[int] = None

• filename: Optional[str] = None

• category: Optional[str] = None

• label: Optional[str] = None

Class variables

• category: Optional[str]

• filename: Optional[str]

• label: Optional[str]

• sample_id: Optional[int]

SampleIngestionResponse

class 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

• sample: edgeimpulse.data.sample_type.Sample

• response: dict

Sensor

class 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

• 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'

Class variables

• 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']

UploadSamplesResponse

class 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

• successes: List[edgeimpulse.data.sample_type.SampleIngestionResponse]

• fails: List[edgeimpulse.data.sample_type.SampleIngestionResponse]

Methods

extend

edgeimpulse.data.sample_type.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

• successes: List[edgeimpulse.data.sample_type.SampleIngestionResponse]

• fails: List[edgeimpulse.data.sample_type.SampleIngestionResponse]

Sample

class edgeimpulse.experimental.data.Sample(
		data: Union[io.BufferedIOBase, _io.StringIO, str],
		filename: Optional[str] = None,
		category: Optional[Literal['training', 'testing', 'anomaly', 'split']] = 'split',
		label: Optional[str] = None,
		bounding_boxes: Optional[List[dict]] = None,
		metadata: Optional[dict] = None,
		sample_id: Optional[int] = None,
		structured_labels: Optional[List[dict]] = 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

• data: Union[io.BufferedIOBase, _io.StringIO, str]

• filename: Optional[str] = None

• category: Optional[Literal['training', 'testing', 'anomaly', 'split']] = 'split'

• label: Optional[str] = None

• bounding_boxes: Optional[List[dict]] = None

• metadata: Optional[dict] = None

• sample_id: Optional[int] = None

• structured_labels: Optional[List[dict]] = None

Class variables

• bounding_boxes: Optional[List[dict]]

• category: Optional[Literal['training', 'testing', 'anomaly', 'split']]

• data: Union[io.BufferedIOBase, _io.StringIO, str]

• filename: Optional[str]

• label: Optional[str]

• metadata: Optional[dict]

• sample_id: Optional[int]

• structured_labels: Optional[List[dict]]

delete_all_samples

edgeimpulse.experimental.data.delete_all_samples(
		category: Optional[str] = None,
		api_key: Optional[str] = None,
		timeout_sec: Optional[float] = None
) ‑> Optional[edgeimpulse_api.models.generic_api_response.GenericApiResponse]

Delete all samples in a given category.

If category is set to None, all samples in the project are deleted.

Parameters

• category: Optional[str] = None

• api_key: Optional[str] = None

• timeout_sec: Optional[float] = None

Return

Optional[edgeimpulse_api.models.generic_api_response.GenericApiResponse]

delete_sample_by_id

edgeimpulse.experimental.data.delete_sample_by_id(
		sample_id: int,
		api_key: Optional[str] = None,
		timeout_sec: Optional[float] = None
) ‑> Optional[edgeimpulse_api.models.generic_api_response.GenericApiResponse]

Delete a particular sample from a project given the sample ID.

Parameters

• sample_id: int

• api_key: Optional[str] = None

• timeout_sec: Optional[float] = None

Return

Optional[edgeimpulse_api.models.generic_api_response.GenericApiResponse]

delete_samples_by_filename

edgeimpulse.experimental.data.delete_samples_by_filename(
		filename: str,
		category: Optional[str] = None,
		api_key: Optional[str] = None,
		timeout_sec: Optional[float] = None
) ‑> Tuple[Optional[Any], ...]

Delete any samples from an Edge Impulse project that match the given filename.

Note: the filename argument must not include the original extension. For example, if you uploaded a file named my-image.01.png, you must provide the filename as my-image.01.

Parameters

• filename: str

• category: Optional[str] = None

• api_key: Optional[str] = None

• timeout_sec: Optional[float] = None

Return

Tuple[Optional[Any], ...]

download_samples_by_ids

edgeimpulse.experimental.data.download_samples_by_ids(
		sample_ids: Union[int, List[int]],
		api_key: Optional[str] = None,
		timeout_sec: Optional[float] = None,
		max_workers: Optional[int] = None,
		show_progress: Optional[bool] = False,
		pool_maxsize: Optional[int] = 20,
		pool_connections: Optional[int] = 20
) ‑> List[edgeimpulse.data.sample_type.Sample]

Download samples by their associated IDs from an Edge Impulse project.

Downloaded sample data is returned as a DownloadSample object, which contains the raw data in a BytesIO object along with associated metadata.

Important! All time series data is returned as a JSON file (in BytesIO format) with a timestamp column. This includes files originally uploaded as CSV, JSON, and CBOR. Edge Impulse Studio removes the timestamp column from any uploaded CSV files and computes an estimated sample rate. The timestamps are computed based on the sample rate, will always start at 0, and will be in milliseconds. These timestamps may not be the same as the original timestamps in the uploaded file.

Parameters

• sample_ids: Union[int, List[int]]

• api_key: Optional[str] = None

• timeout_sec: Optional[float] = None

• max_workers: Optional[int] = None

• show_progress: Optional[bool] = False

• pool_maxsize: Optional[int] = 20

• pool_connections: Optional[int] = 20

Return

List[edgeimpulse.data.sample_type.Sample]

get_filename_by_id

edgeimpulse.experimental.data.get_filename_by_id(
		sample_id: int,
		api_key: Optional[str] = None,
		timeout_sec: Optional[float] = None
) ‑> Optional[str]

Given an ID for a sample in a project, return the filename associated with that sample.

Note that while multiple samples can have the same filename, each sample has a unique sample ID that is provided by Studio when the sample is uploaded.

Parameters

• sample_id: int

• api_key: Optional[str] = None

• timeout_sec: Optional[float] = None

Return

Optional[str]

get_sample_ids

edgeimpulse.experimental.data.get_sample_ids(
		filename: Optional[str] = None,
		category: Optional[str] = None,
		labels: Optional[str] = None,
		api_key: Optional[str] = None,
		num_workers: Optional[int] = 4,
		timeout_sec: Optional[float] = None
) ‑> List[edgeimpulse.data.sample_type.SampleInfo]

Get the sample IDs and filenames for all samples in a project, filtered by category, labels, or filename.

Note that filenames are given by the root of the filename when uploaded. For example, if you upload my-image.01.png, it will be stored in your project with a hash such as my-image.01.png.4f262n1b.json. To find the ID(s) that match this sample, you must provide the argument filename=my-image.01. Notice the lack of extension and hash.

Because of the potential for multiple samples (i.e., different sample IDs) with the same filename, we recommend providing unique filenames for your samples when uploading.

Parameters

• filename: Optional[str] = None

• category: Optional[str] = None

• labels: Optional[str] = None

• api_key: Optional[str] = None

• num_workers: Optional[int] = 4

• timeout_sec: Optional[float] = None

Return

List[edgeimpulse.data.sample_type.SampleInfo]

infer_category_and_label_from_filename

edgeimpulse.experimental.data.infer_category_and_label_from_filename(
		sample: edgeimpulse.data.sample_type.Sample,
		file: str
) ‑> None

Extract label and category information from the filename and assigns them to the sample object.

Files should look like this my-dataset/training/wave.1.cbor where wave is the label and training is the category. It checks if there is training, testing or anomaly in the filename to determine the sample category.

Parameters

• sample: edgeimpulse.data.sample_type.Sample

• file: str

Return

None

numpy_timeseries_to_sample

edgeimpulse.experimental.data.numpy_timeseries_to_sample(
		values,
		sensors: List[edgeimpulse.data.sample_type.Sensor],
		sample_rate_ms: int
) ‑> edgeimpulse.data.sample_type.Sample

Convert numpy values to a sample that can be uploaded to Edge Impulse.

Parameters

• values

• sensors: List[edgeimpulse.data.sample_type.Sensor]

• sample_rate_ms: int

Return

edgeimpulse.data.sample_type.Sample

pandas_dataframe_to_sample

edgeimpulse.experimental.data.pandas_dataframe_to_sample(
		df,
		sample_rate_ms: Optional[int] = None,
		label: Optional[str] = None,
		filename: Optional[str] = None,
		axis_columns: Optional[List[str]] = None,
		metadata: Optional[dict] = None,
		label_col: Optional[str] = None,
		category: Literal['training', 'testing', 'split'] = 'split'
) ‑> edgeimpulse.data.sample_type.Sample

Convert a dataframe to a single sample. Can handle both timeseries and non-timeseries data.

In order to be inferred as timeseries it must have:

• More than one row

• A sample rate or an index from which the sample rate can be inferred

  • Therefore must be monotonically increasing

  • And int or a date

Parameters

• df

• sample_rate_ms: Optional[int] = None

• label: Optional[str] = None

• filename: Optional[str] = None

• axis_columns: Optional[List[str]] = None

• metadata: Optional[dict] = None

• label_col: Optional[str] = None

• category: Literal['training', 'testing', 'split'] = 'split'

Return

edgeimpulse.data.sample_type.Sample

stream_samples_by_ids

edgeimpulse.experimental.data.stream_samples_by_ids(
		sample_ids: Union[int, Sequence[int]],
		api_key: Optional[str] = None,
		timeout_sec: Optional[float] = None,
		max_workers: Optional[int] = None,
		show_progress: Optional[bool] = False,
		pool_maxsize: Optional[int] = 20,
		pool_connections: Optional[int] = 20
) ‑> Generator[edgeimpulse.data.sample_type.Sample, None, None]

Download samples by their associated IDs from an Edge Impulse project.

Parameters

• sample_ids: Union[int, Sequence[int]]

• api_key: Optional[str] = None

• timeout_sec: Optional[float] = None

• max_workers: Optional[int] = None

• show_progress: Optional[bool] = False

• pool_maxsize: Optional[int] = 20

• pool_connections: Optional[int] = 20

Return

Generator[edgeimpulse.data.sample_type.Sample, None, None]

upload_directory

edgeimpulse.experimental.data.upload_directory(
		directory: str,
		category: Optional[str] = None,
		label: Optional[str] = None,
		metadata: Optional[dict] = None,
		transform: Optional[<built-in function callable>] = None,
		allow_duplicates: Optional[bool] = False,
		show_progress: Optional[bool] = False,
		batch_size: Optional[int] = 1024
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload a directory of files to Edge Impulse.

Tries to autodetect whether it's an Edge Impulse exported dataset, or a standard directory. The files can be in CBOR, JSON, image, or WAV file formats. You can read more about the different file formats accepted by the Edge Impulse ingestion service here:

https://docs.edgeimpulse.com/reference/ingestion-api

Parameters

• directory: str

• category: Optional[str] = None

• label: Optional[str] = None

• metadata: Optional[dict] = None

• transform: Optional[<built-in function callable>] = None

• allow_duplicates: Optional[bool] = False

• show_progress: Optional[bool] = False

• batch_size: Optional[int] = 1024

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_exported_dataset

edgeimpulse.experimental.data.upload_exported_dataset(
		directory: str,
		transform: Optional[<built-in function callable>] = None,
		allow_duplicates: Optional[bool] = False,
		show_progress: Optional[bool] = False,
		batch_size: Optional[int] = 1024
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload samples from a downloaded Edge Impulse dataset and preserve the info.labels information.

Use this when you've exported your data in the studio, via the export functionality.

Parameters

• directory: str

• transform: Optional[<built-in function callable>] = None

• allow_duplicates: Optional[bool] = False

• show_progress: Optional[bool] = False

• batch_size: Optional[int] = 1024

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_numpy

edgeimpulse.experimental.data.upload_numpy(
		data,
		labels: List[str],
		sensors: List[edgeimpulse.data.sample_type.Sensor],
		sample_rate_ms: int,
		metadata: Optional[dict] = None,
		category: Literal['training', 'testing', 'split', 'anomaly'] = 'split'
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload numpy arrays as timeseries using the Edge Impulse data acquisition format.

Parameters

• data

• labels: List[str]

• sensors: List[edgeimpulse.data.sample_type.Sensor]

• sample_rate_ms: int

• metadata: Optional[dict] = None

• category: Literal['training', 'testing', 'split', 'anomaly'] = 'split'

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_pandas_dataframe

edgeimpulse.experimental.data.upload_pandas_dataframe(
		df,
		feature_cols: List[str],
		label_col: Optional[str] = None,
		category_col: Optional[str] = None,
		metadata_cols: Optional[List[str]] = None
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload non-timeseries data to Edge Impulse where each dataframe row becomes a sample.

Parameters

• df

• feature_cols: List[str]

• label_col: Optional[str] = None

• category_col: Optional[str] = None

• metadata_cols: Optional[List[str]] = None

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_pandas_dataframe_wide

edgeimpulse.experimental.data.upload_pandas_dataframe_wide(
		df,
		sample_rate_ms: int,
		data_col_start: Optional[int] = None,
		label_col: Optional[str] = None,
		category_col: Optional[str] = None,
		metadata_cols: Optional[List[str]] = None,
		data_col_length: Optional[int] = None,
		data_axis_cols: Optional[List[str]] = None
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload a dataframe to Edge Impulse where each column represents a value in the timeseries data and the rows become the individual samples.

Parameters

• df

• sample_rate_ms: int

• data_col_start: Optional[int] = None

• label_col: Optional[str] = None

• category_col: Optional[str] = None

• metadata_cols: Optional[List[str]] = None

• data_col_length: Optional[int] = None

• data_axis_cols: Optional[List[str]] = None

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_pandas_dataframe_with_group

edgeimpulse.experimental.data.upload_pandas_dataframe_with_group(
		df,
		timestamp_col: str,
		group_by: str,
		feature_cols: List[str],
		label_col: Optional[str] = None,
		category_col: Optional[str] = None,
		metadata_cols: Optional[List[str]] = None
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload a dataframe where the rows contain multiple samples and timeseries data for those samples.

It uses a group_by in order to detect what timeseries value belongs to which sample.

Parameters

• df

• timestamp_col: str

• group_by: str

• feature_cols: List[str]

• label_col: Optional[str] = None

• category_col: Optional[str] = None

• metadata_cols: Optional[List[str]] = None

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_pandas_sample

edgeimpulse.experimental.data.upload_pandas_sample(
		df,
		label: Optional[str] = None,
		sample_rate_ms: Optional[int] = None,
		filename: Optional[str] = None,
		axis_columns: Optional[List[str]] = None,
		metadata: Optional[dict] = None,
		label_col: Optional[str] = None,
		category: Literal['training', 'testing', 'split'] = 'split'
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload a single dataframe sample.

Upload a single dataframe sample to Edge Impulse.

Parameters

• df

• label: Optional[str] = None

• sample_rate_ms: Optional[int] = None

• filename: Optional[str] = None

• axis_columns: Optional[List[str]] = None

• metadata: Optional[dict] = None

• label_col: Optional[str] = None

• category: Literal['training', 'testing', 'split'] = 'split'

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_plain_directory

edgeimpulse.experimental.data.upload_plain_directory(
		directory: str,
		category: Optional[str] = None,
		label: Optional[str] = None,
		metadata: Optional[dict] = None,
		transform: Optional[<built-in function callable>] = None,
		allow_duplicates: Optional[bool] = False,
		show_progress: Optional[bool] = False,
		batch_size: Optional[int] = 1024
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload a directory of files to Edge Impulse.

The samples can be in CBOR, JSON, image, or WAV file formats.

Parameters

• directory: str

• category: Optional[str] = None

• label: Optional[str] = None

• metadata: Optional[dict] = None

• transform: Optional[<built-in function callable>] = None

• allow_duplicates: Optional[bool] = False

• show_progress: Optional[bool] = False

• batch_size: Optional[int] = 1024

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_samples

edgeimpulse.experimental.data.upload_samples(
		samples: Union[edgeimpulse.data.sample_type.Sample, List[edgeimpulse.data.sample_type.Sample]],
		allow_duplicates: Optional[bool] = False,
		api_key: Optional[str] = None,
		timeout_sec: Optional[float] = None,
		max_workers: Optional[int] = None,
		show_progress: Optional[bool] = False,
		pool_maxsize: Optional[int] = 20,
		pool_connections: Optional[int] = 20
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload one or more samples to an Edge Impulse project using the ingestion service.

Each sample must be wrapped in a Sample object, which contains metadata about that sample. Give this function a single Sample or a List of Sample objects to upload to your project. The data field of the Sample must be a raw binary stream, such as a BufferedIOBase object (which you can create with the open(..., "rb") function).

Parameters

• samples: Union[edgeimpulse.data.sample_type.Sample, List[edgeimpulse.data.sample_type.Sample]]

• allow_duplicates: Optional[bool] = False

• api_key: Optional[str] = None

• timeout_sec: Optional[float] = None

• max_workers: Optional[int] = None

• show_progress: Optional[bool] = False

• pool_maxsize: Optional[int] = 20

• pool_connections: Optional[int] = 20

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

Submodules

• edgeimpulse.data.sample_type

Sample

class edgeimpulse.data.Sample(
		data: Union[io.BufferedIOBase, _io.StringIO, str],
		filename: Optional[str] = None,
		category: Optional[Literal['training', 'testing', 'anomaly', 'split']] = 'split',
		label: Optional[str] = None,
		bounding_boxes: Optional[List[dict]] = None,
		metadata: Optional[dict] = None,
		sample_id: Optional[int] = None,
		structured_labels: Optional[List[dict]] = 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

• data: Union[io.BufferedIOBase, _io.StringIO, str]

• filename: Optional[str] = None

• category: Optional[Literal['training', 'testing', 'anomaly', 'split']] = 'split'

• label: Optional[str] = None

• bounding_boxes: Optional[List[dict]] = None

• metadata: Optional[dict] = None

• sample_id: Optional[int] = None

• structured_labels: Optional[List[dict]] = None

Class variables

• bounding_boxes: Optional[List[dict]]

• category: Optional[Literal['training', 'testing', 'anomaly', 'split']]

• data: Union[io.BufferedIOBase, _io.StringIO, str]

• filename: Optional[str]

• label: Optional[str]

• metadata: Optional[dict]

• sample_id: Optional[int]

• structured_labels: Optional[List[dict]]

delete_all_samples

edgeimpulse.data.delete_all_samples(
		category: Optional[str] = None,
		api_key: Optional[str] = None,
		timeout_sec: Optional[float] = None
) ‑> Optional[edgeimpulse_api.models.generic_api_response.GenericApiResponse]

Delete all samples in a given category.

If category is set to None, all samples in the project are deleted.

Parameters

• category: Optional[str] = None

• api_key: Optional[str] = None

• timeout_sec: Optional[float] = None

Return

Optional[edgeimpulse_api.models.generic_api_response.GenericApiResponse]

delete_sample_by_id

edgeimpulse.data.delete_sample_by_id(
		sample_id: int,
		api_key: Optional[str] = None,
		timeout_sec: Optional[float] = None
) ‑> Optional[edgeimpulse_api.models.generic_api_response.GenericApiResponse]

Delete a particular sample from a project given the sample ID.

Parameters

• sample_id: int

• api_key: Optional[str] = None

• timeout_sec: Optional[float] = None

Return

Optional[edgeimpulse_api.models.generic_api_response.GenericApiResponse]

delete_samples_by_filename

edgeimpulse.data.delete_samples_by_filename(
		filename: str,
		category: Optional[str] = None,
		api_key: Optional[str] = None,
		timeout_sec: Optional[float] = None
) ‑> Tuple[Optional[Any], ...]

Delete any samples from an Edge Impulse project that match the given filename.

Note: the filename argument must not include the original extension. For example, if you uploaded a file named my-image.01.png, you must provide the filename as my-image.01.

Parameters

• filename: str

• category: Optional[str] = None

• api_key: Optional[str] = None

• timeout_sec: Optional[float] = None

Return

Tuple[Optional[Any], ...]

download_samples_by_ids

edgeimpulse.data.download_samples_by_ids(
		sample_ids: Union[int, List[int]],
		api_key: Optional[str] = None,
		timeout_sec: Optional[float] = None,
		max_workers: Optional[int] = None,
		show_progress: Optional[bool] = False,
		pool_maxsize: Optional[int] = 20,
		pool_connections: Optional[int] = 20
) ‑> List[edgeimpulse.data.sample_type.Sample]

Download samples by their associated IDs from an Edge Impulse project.

Downloaded sample data is returned as a DownloadSample object, which contains the raw data in a BytesIO object along with associated metadata.

Important! All time series data is returned as a JSON file (in BytesIO format) with a timestamp column. This includes files originally uploaded as CSV, JSON, and CBOR. Edge Impulse Studio removes the timestamp column from any uploaded CSV files and computes an estimated sample rate. The timestamps are computed based on the sample rate, will always start at 0, and will be in milliseconds. These timestamps may not be the same as the original timestamps in the uploaded file.

Parameters

• sample_ids: Union[int, List[int]]

• api_key: Optional[str] = None

• timeout_sec: Optional[float] = None

• max_workers: Optional[int] = None

• show_progress: Optional[bool] = False

• pool_maxsize: Optional[int] = 20

• pool_connections: Optional[int] = 20

Return

List[edgeimpulse.data.sample_type.Sample]

get_filename_by_id

edgeimpulse.data.get_filename_by_id(
		sample_id: int,
		api_key: Optional[str] = None,
		timeout_sec: Optional[float] = None
) ‑> Optional[str]

Given an ID for a sample in a project, return the filename associated with that sample.

Note that while multiple samples can have the same filename, each sample has a unique sample ID that is provided by Studio when the sample is uploaded.

Parameters

• sample_id: int

• api_key: Optional[str] = None

• timeout_sec: Optional[float] = None

Return

Optional[str]

get_sample_ids

edgeimpulse.data.get_sample_ids(
		filename: Optional[str] = None,
		category: Optional[str] = None,
		labels: Optional[str] = None,
		api_key: Optional[str] = None,
		num_workers: Optional[int] = 4,
		timeout_sec: Optional[float] = None
) ‑> List[edgeimpulse.data.sample_type.SampleInfo]

Get the sample IDs and filenames for all samples in a project, filtered by category, labels, or filename.

Note that filenames are given by the root of the filename when uploaded. For example, if you upload my-image.01.png, it will be stored in your project with a hash such as my-image.01.png.4f262n1b.json. To find the ID(s) that match this sample, you must provide the argument filename=my-image.01. Notice the lack of extension and hash.

Because of the potential for multiple samples (i.e., different sample IDs) with the same filename, we recommend providing unique filenames for your samples when uploading.

Parameters

• filename: Optional[str] = None

• category: Optional[str] = None

• labels: Optional[str] = None

• api_key: Optional[str] = None

• num_workers: Optional[int] = 4

• timeout_sec: Optional[float] = None

Return

List[edgeimpulse.data.sample_type.SampleInfo]

infer_from_filename

edgeimpulse.data.infer_from_filename(
		sample: edgeimpulse.data.sample_type.Sample,
		file: str
) ‑> None

Extract label and category information from the filename and assigns them to the sample object.

Files should look like this my-dataset/training/wave.1.cbor where wave is the label and training is the category. It checks if there is training, testing or anomaly in the filename to determine the sample category.

Parameters

• sample: edgeimpulse.data.sample_type.Sample

• file: str

Return

None

numpy_timeseries_to_sample

edgeimpulse.data.numpy_timeseries_to_sample(
		values,
		sensors: List[edgeimpulse.data.sample_type.Sensor],
		sample_rate_ms: int
) ‑> edgeimpulse.data.sample_type.Sample

Convert numpy values to a sample that can be uploaded to Edge Impulse.

Parameters

• values

• sensors: List[edgeimpulse.data.sample_type.Sensor]

• sample_rate_ms: int

Return

edgeimpulse.data.sample_type.Sample

pandas_dataframe_to_sample

edgeimpulse.data.pandas_dataframe_to_sample(
		df,
		sample_rate_ms: Optional[int] = None,
		label: Optional[str] = None,
		filename: Optional[str] = None,
		axis_columns: Optional[List[str]] = None,
		metadata: Optional[dict] = None,
		label_col: Optional[str] = None,
		category: Literal['training', 'testing', 'split'] = 'split'
) ‑> edgeimpulse.data.sample_type.Sample

Convert a dataframe to a single sample. Can handle both timeseries and non-timeseries data.

In order to be inferred as timeseries it must have:

• More than one row

• A sample rate or an index from which the sample rate can be inferred

  • Therefore must be monotonically increasing

  • And int or a date

Parameters

• df

• sample_rate_ms: Optional[int] = None

• label: Optional[str] = None

• filename: Optional[str] = None

• axis_columns: Optional[List[str]] = None

• metadata: Optional[dict] = None

• label_col: Optional[str] = None

• category: Literal['training', 'testing', 'split'] = 'split'

Return

edgeimpulse.data.sample_type.Sample

upload_directory

edgeimpulse.data.upload_directory(
		directory: str,
		category: Optional[str] = None,
		label: Optional[str] = None,
		metadata: Optional[dict] = None,
		transform: Optional[<built-in function callable>] = None,
		allow_duplicates: Optional[bool] = False,
		show_progress: Optional[bool] = False,
		batch_size: Optional[int] = 1024
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload a directory of files to Edge Impulse.

Tries to autodetect whether it's an Edge Impulse exported dataset, or a standard directory. The files can be in CBOR, JSON, image, or WAV file formats. You can read more about the different file formats accepted by the Edge Impulse ingestion service here:

https://docs.edgeimpulse.com/reference/ingestion-api

Parameters

• directory: str

• category: Optional[str] = None

• label: Optional[str] = None

• metadata: Optional[dict] = None

• transform: Optional[<built-in function callable>] = None

• allow_duplicates: Optional[bool] = False

• show_progress: Optional[bool] = False

• batch_size: Optional[int] = 1024

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_exported_dataset

edgeimpulse.data.upload_exported_dataset(
		directory: str,
		transform: Optional[<built-in function callable>] = None,
		allow_duplicates: Optional[bool] = False,
		show_progress: Optional[bool] = False,
		batch_size: Optional[int] = 1024
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload samples from a downloaded Edge Impulse dataset and preserve the info.labels information.

Use this when you've exported your data in the studio, via the export functionality.

Parameters

• directory: str

• transform: Optional[<built-in function callable>] = None

• allow_duplicates: Optional[bool] = False

• show_progress: Optional[bool] = False

• batch_size: Optional[int] = 1024

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_numpy

edgeimpulse.data.upload_numpy(
		data,
		labels: List[str],
		sensors: List[edgeimpulse.data.sample_type.Sensor],
		sample_rate_ms: int,
		metadata: Optional[dict] = None,
		category: Literal['training', 'testing', 'split', 'anomaly'] = 'split'
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload numpy arrays as timeseries using the Edge Impulse data acquisition format.

Parameters

• data

• labels: List[str]

• sensors: List[edgeimpulse.data.sample_type.Sensor]

• sample_rate_ms: int

• metadata: Optional[dict] = None

• category: Literal['training', 'testing', 'split', 'anomaly'] = 'split'

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_pandas_dataframe

edgeimpulse.data.upload_pandas_dataframe(
		df,
		feature_cols: List[str],
		label_col: Optional[str] = None,
		category_col: Optional[str] = None,
		metadata_cols: Optional[List[str]] = None
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload non-timeseries data to Edge Impulse where each dataframe row becomes a sample.

Parameters

• df

• feature_cols: List[str]

• label_col: Optional[str] = None

• category_col: Optional[str] = None

• metadata_cols: Optional[List[str]] = None

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_pandas_dataframe_wide

edgeimpulse.data.upload_pandas_dataframe_wide(
		df,
		sample_rate_ms: int,
		data_col_start: Optional[int] = None,
		label_col: Optional[str] = None,
		category_col: Optional[str] = None,
		metadata_cols: Optional[List[str]] = None,
		data_col_length: Optional[int] = None,
		data_axis_cols: Optional[List[str]] = None
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload a dataframe to Edge Impulse where each column represents a value in the timeseries data and the rows become the individual samples.

Parameters

• df

• sample_rate_ms: int

• data_col_start: Optional[int] = None

• label_col: Optional[str] = None

• category_col: Optional[str] = None

• metadata_cols: Optional[List[str]] = None

• data_col_length: Optional[int] = None

• data_axis_cols: Optional[List[str]] = None

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_pandas_dataframe_with_group

edgeimpulse.data.upload_pandas_dataframe_with_group(
		df,
		timestamp_col: str,
		group_by: str,
		feature_cols: List[str],
		label_col: Optional[str] = None,
		category_col: Optional[str] = None,
		metadata_cols: Optional[List[str]] = None
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload a dataframe where the rows contain multiple samples and timeseries data for those samples.

It uses a group_by in order to detect what timeseries value belongs to which sample.

Parameters

• df

• timestamp_col: str

• group_by: str

• feature_cols: List[str]

• label_col: Optional[str] = None

• category_col: Optional[str] = None

• metadata_cols: Optional[List[str]] = None

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_pandas_sample

edgeimpulse.data.upload_pandas_sample(
		df,
		label: Optional[str] = None,
		sample_rate_ms: Optional[int] = None,
		filename: Optional[str] = None,
		axis_columns: Optional[List[str]] = None,
		metadata: Optional[dict] = None,
		label_col: Optional[str] = None,
		category: Literal['training', 'testing', 'split'] = 'split'
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload a single dataframe sample.

Upload a single dataframe sample to Edge Impulse.

Parameters

• df

• label: Optional[str] = None

• sample_rate_ms: Optional[int] = None

• filename: Optional[str] = None

• axis_columns: Optional[List[str]] = None

• metadata: Optional[dict] = None

• label_col: Optional[str] = None

• category: Literal['training', 'testing', 'split'] = 'split'

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_plain_directory

edgeimpulse.data.upload_plain_directory(
		directory: str,
		category: Optional[str] = None,
		label: Optional[str] = None,
		metadata: Optional[dict] = None,
		transform: Optional[<built-in function callable>] = None,
		allow_duplicates: Optional[bool] = False,
		show_progress: Optional[bool] = False,
		batch_size: Optional[int] = 1024
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload a directory of files to Edge Impulse.

The samples can be in CBOR, JSON, image, or WAV file formats.

Parameters

• directory: str

• category: Optional[str] = None

• label: Optional[str] = None

• metadata: Optional[dict] = None

• transform: Optional[<built-in function callable>] = None

• allow_duplicates: Optional[bool] = False

• show_progress: Optional[bool] = False

• batch_size: Optional[int] = 1024

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_samples

edgeimpulse.data.upload_samples(
		samples: Union[edgeimpulse.data.sample_type.Sample, List[edgeimpulse.data.sample_type.Sample]],
		allow_duplicates: Optional[bool] = False,
		api_key: Optional[str] = None,
		timeout_sec: Optional[float] = None,
		max_workers: Optional[int] = None,
		show_progress: Optional[bool] = False,
		pool_maxsize: Optional[int] = 20,
		pool_connections: Optional[int] = 20
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload one or more samples to an Edge Impulse project using the ingestion service.

Each sample must be wrapped in a Sample object, which contains metadata about that sample. Give this function a single Sample or a List of Sample objects to upload to your project. The data field of the Sample must be a raw binary stream, such as a BufferedIOBase object (which you can create with the open(..., "rb") function).

Parameters

• samples: Union[edgeimpulse.data.sample_type.Sample, List[edgeimpulse.data.sample_type.Sample]]

• allow_duplicates: Optional[bool] = False

• api_key: Optional[str] = None

• timeout_sec: Optional[float] = None

• max_workers: Optional[int] = None

• show_progress: Optional[bool] = False

• pool_maxsize: Optional[int] = 20

• pool_connections: Optional[int] = 20

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

EdgeImpulseApi

class edgeimpulse.experimental.api.EdgeImpulseApi(
		host: Optional[str] = None,
		key: Optional[str] = None,
		key_type: str = 'api'
)

Initialize the Edge Impulse Api.

Parameters

• host: Optional[str] = None

• key: Optional[str] = None

• key_type: str = 'api'

Instance variables

• classify: edgeimpulse_api.api.classify_api.ClassifyApi Classify samples in your project.

• client: edgeimpulse_api.api_client.ApiClient The client used for initializing the apis, use set_client to update the client.

• deployment: edgeimpulse_api.api.deployment_api.DeploymentApi Work with your model deployment targets.

• devices: edgeimpulse_api.api.devices_api.DevicesApi Work with devices in your project.

• dsp: edgeimpulse_api.api.dsp_api.DSPApi Work with (DSP) digital signal processing and feature extraction blocks in your project.

• export: edgeimpulse_api.api.export_api.ExportApi Export your project.

• host: Optional[str] Edge Impulse studio host (defaults to production).

• impulse: edgeimpulse_api.api.impulse_api.ImpulseApi Work and manage your Impulse (on-device feature extraction and classification pipeline).

• jobs: edgeimpulse_api.api.jobs_api.JobsApi Start and manage long running jobs.

• learn: edgeimpulse_api.api.learn_api.LearnApi Work with keras and pretrained models.

• login: edgeimpulse_api.api.login_api.LoginApi Login and authenticate.

• optimization: edgeimpulse_api.api.optimization_api.OptimizationApi Optimize and find a better model with the EON tuner.

• organization_blocks: edgeimpulse_api.api.organization_blocks_api.OrganizationBlocksApi Work with organization blocks.

• organization_create_project: edgeimpulse_api.api.organization_create_project_api.OrganizationCreateProjectApi Automate project creation for organizations.

• organization_data: edgeimpulse_api.api.organization_data_api.OrganizationDataApi Work with organization data.

• organization_data_campaigns: edgeimpulse_api.api.organization_data_campaigns_api.OrganizationDataCampaignsApi Work with organization data campaigns.

• organization_jobs: edgeimpulse_api.api.organization_jobs_api.OrganizationJobsApi Start and manage organization jobs.

• organization_pipelines: edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi Work with organization pipelines.

• organization_portals: edgeimpulse_api.api.organization_portals_api.OrganizationPortalsApi Create and manage organization portals.

• organizations: edgeimpulse_api.api.organizations_api.OrganizationsApi Work with your organizations.

• performance_calibration: edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi Calibrate your model performance with real world data.

• projects: edgeimpulse_api.api.projects_api.ProjectsApi Create and manage your projects.

• raw_data: edgeimpulse_api.api.raw_data_api.RawDataApi Work with your project data.

• upload_portal: edgeimpulse_api.api.upload_portal_api.UploadPortalApi Create and manage data upload portals.

• user: edgeimpulse_api.api.user_api.UserApi Manage user activation, creation and updates.

Methods

authenticate

edgeimpulse.experimental.api.authenticate(
		self,
		key: str,
		key_type: str = 'api',
		host: Optional[str] = None
) ‑> None

Authenticate against Edge Impulse.

Parameters

• self

• key: str

• key_type: str = 'api'

• host: Optional[str] = None

Return

None

default_project_id

edgeimpulse.experimental.api.default_project_id(
		self
) ‑> int

Get the default project ID from the provided API key.

Returns: int: The project associated with the api key.

Parameters

• self

Return

int

run_organization_job_until_completion

edgeimpulse.experimental.api.run_organization_job_until_completion(
		self,
		organization_id: int,
		job_id: int,
		data_cb=None,
		client=None,
		timeout_sec: Optional[int] = None
) ‑> None

Runs an organization job until completion.

Parameters

• self

• organization_id: int

• job_id: int

• data_cb=None

• client=None

• timeout_sec: Optional[int] = None

Return

None

run_project_job_until_completion

edgeimpulse.experimental.api.run_project_job_until_completion(
		self,
		job_id: int,
		data_cb=None,
		client=None,
		project_id: Optional[int] = None,
		timeout_sec: Optional[int] = None
) ‑> None

Runs a project job until completion.

Parameters

• self

• job_id: int

• data_cb=None

• client=None

• project_id: Optional[int] = None

• timeout_sec: Optional[int] = None

Return

None

set_client

edgeimpulse.experimental.api.set_client(
		self,
		client: edgeimpulse_api.api_client.ApiClient
) ‑> None

Set the API client and initialize the APIs wit that client.

Parameters

• self

• client: edgeimpulse_api.api_client.ApiClient

Return

None

AudioInput

class edgeimpulse.model.input_type.AudioInput(
		frequency_hz: float
)

Parameters

• frequency_hz: float

Bases

• builtins.dict

ImageInput

class edgeimpulse.model.input_type.ImageInput(
		scaling_range: Literal['0..1', '0..255', 'torch'] = '0..1'
)

Parameters

• scaling_range: Literal['0..1', '0..255', 'torch'] = '0..1'

Bases

• builtins.dict

OtherInput

class edgeimpulse.model.input_type.OtherInput(
		
)

Bases

• builtins.dict

TimeSeriesInput

class edgeimpulse.model.input_type.TimeSeriesInput(
		frequency_hz: float,
		windowlength_ms: int
)

Parameters

• frequency_hz: float

• windowlength_ms: int

Bases

• builtins.dict

add_labels_to_dataframe

edgeimpulse.experimental.util.add_labels_to_dataframe(
		df,
		labels,
		label_col_name='label'
)

Adds labels to a DataFrame based on provided label information.

Parameters

• df

• labels

• label_col_name='label'

convert_json_cbor_to_dataframe

edgeimpulse.experimental.util.convert_json_cbor_to_dataframe(
		data,
		ts_col_name=None
)

Converts JSON CBOR data to a pandas DataFrame.

Parameters

• data

• ts_col_name=None

convert_sample_to_dataframe

edgeimpulse.experimental.util.convert_sample_to_dataframe(
		sample,
		label_col_name: Optional[str] = 'label',
		ts_col_name: Optional[str] = None
)

Converts a sample to a DataFrame and adds labels if provided.

Parameters

• sample

• label_col_name: Optional[str] = 'label'

• ts_col_name: Optional[str] = None