Home Studio Docs
Projects
Forum

data package

Sample

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

  • filename: Optional[str] = None

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

  • label: Optional[str] = None

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

  • metadata: Optional[dict] = None

  • sample_id: Optional[int] = None

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

Class variables

  • bounding_boxes: Optional[Sequence[dict]]

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

  • data: io.BufferedIOBase

  • filename: Optional[str]

  • label: Optional[str]

  • metadata: Optional[dict]

  • sample_id: Optional[int]

  • structured_labels: Optional[Sequence[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
) ‑> Optional[Tuple[edgeimpulse_api.models.generic_api_response.GenericApiResponse]]

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

Optional[Tuple[edgeimpulse_api.models.generic_api_response.GenericApiResponse]]

download_samples_by_ids

edgeimpulse.experimental.data.download_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
) ‑> 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 in 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, 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

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, and/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 possibility 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,
		file
) ‑> None

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

Files should look like this myfiles/training/wave.1.cbor where wave is label and training is the category.

Parameters

  • sample

  • file

Return

None

numpy_timeseries_to_sample

edgeimpulse.experimental.data.numpy_timeseries_to_sample(
		values,
		sensors: Sequence[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: Sequence[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,
		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

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

Return

edgeimpulse.data.sample_type.Sample

upload_directory

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

Upload a directory of files to Edge Impulse.

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: str = None

  • label: str = None

  • metadata: dict = None

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

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_exported_dataset

edgeimpulse.experimental.data.upload_exported_dataset(
		directory: str,
		transform: Optional[<built-in function callable>] = None
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

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

Use this when you've exported your data in the studio.

Parameters

  • directory: str

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

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_numpy

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

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

Parameters

  • data

  • labels: Sequence[str]

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

  • sample_rate_ms: int

  • metadata: dict = None

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

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_pandas_dataframe

edgeimpulse.experimental.data.upload_pandas_dataframe(
		df,
		feature_cols: List[str],
		label_col: 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: 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: List[str] = None,
		data_col_length: Optional[int] = None,
		data_axis_cols: List[str] = None
) ‑> edgeimpulse.data.sample_type.UploadSamplesResponse

Upload a dataframe to Edge Impulse where each of columns represent 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: List[str] = None

  • data_col_length: Optional[int] = None

  • data_axis_cols: 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: str = None,
		sample_rate_ms: int = None,
		filename: str = None,
		axis_columns: Optional[List[str]] = None,
		metadata: Optional[dict] = 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: str = None

  • sample_rate_ms: int = None

  • filename: str = None

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

  • metadata: Optional[dict] = 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: str = None,
		label: str = None,
		metadata: dict = None,
		transform: Optional[<built-in function callable>] = None
) ‑> 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: str = None

  • label: str = None

  • metadata: dict = None

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

Return

edgeimpulse.data.sample_type.UploadSamplesResponse

upload_samples

edgeimpulse.experimental.data.upload_samples(
		samples: Union[edgeimpulse.data.sample_type.Sample, Sequence[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 sequence 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, Sequence[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

Previousexperimental packageNexttuner package

Last updated