jobs_api module#

class edgeimpulse_api.api.jobs_api.JobsApi(api_client=None)[source]#

Bases: object

autotune_dsp_job(

project_id: StrictInt[StrictInt],

autotune_dsp_request: AutotuneDspRequest,

**kwargs,

) → StartJobResponse[source]#

Autotune DSP parameters

Autotune DSP block parameters. Updates are streamed over the websocket API.

Parameters:

project_id (int) – Project ID (required)
autotune_dsp_request (AutotuneDspRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

build_on_device_model_job(

project_id: StrictInt[StrictInt],

type: StrictStr[StrictStr],

build_on_device_model_request: BuildOnDeviceModelRequest,

**kwargs,

) → StartJobResponse[source]#

Build on-device model

Generate code to run the impulse on an embedded device. When this step is complete use downloadBuild to download the artefacts. Updates are streamed over the websocket API.

Parameters:

project_id (int) – Project ID (required)
type (str) – The name of the built target. You can find this by listing all deployment targets through listDeploymentTargetsForProject (via GET /v1/api/{projectId}/deployment/targets) and see the format type. (required)
build_on_device_model_request (BuildOnDeviceModelRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

build_organization_on_device_model_job(

project_id: StrictInt[StrictInt],

build_organization_on_device_model_request: BuildOrganizationOnDeviceModelRequest,

**kwargs,

) → StartJobResponse[source]#

Build organizational on-device model

Generate code to run the impulse on an embedded device using an organizational deployment block. When this step is complete use downloadBuild to download the artefacts. Updates are streamed over the websocket API.

Parameters:

project_id (int) – Project ID (required)
build_organization_on_device_model_request (BuildOrganizationOnDeviceModelRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

calculate_data_quality_metrics(

project_id: StrictInt[StrictInt],

calculate_data_quality_metrics_request: CalculateDataQualityMetricsRequest,

**kwargs,

) → StartJobResponse[source]#

Calculate data quality metrics. Only available for EI staff.

Calculate data quality metrics for the dataset

Parameters:

project_id (int) – Project ID (required)
calculate_data_quality_metrics_request (CalculateDataQualityMetricsRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

cancel_job(

project_id: StrictInt[StrictInt],

job_id: StrictInt[StrictInt],

force_cancel: StrictStr | None[StrictStr | None] = None,

**kwargs,

) → GenericApiResponse[source]#

Cancel job

Cancel a running job.

Parameters:

project_id (int) – Project ID (required)
job_id (int) – Job ID (required)
force_cancel (str) – If set to ‘true’, we won’t wait for the job cluster to cancel the job, and will mark the job as finished.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

download_jobs_logs(

project_id: StrictInt[StrictInt],

job_id: StrictInt[StrictInt],

limit: StrictInt | None[StrictInt | None] = None,

log_level: StrictStr | None[StrictStr | None] = None,

**kwargs,

) → str[source]#

Download logs

Download the logs for a job (as a text file).

Parameters:

project_id (int) – Project ID (required)
job_id (int) – Job ID (required)
limit (int) – Maximum number of results
log_level (str) – Log level (error, warn, info, debug)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

str

export_keras_block(

project_id: StrictInt[StrictInt],

learn_id: StrictInt[StrictInt],

**kwargs,

) → StartJobResponse[source]#

Export Keras block

Export the training pipeline of a Keras block. Updates are streamed over the websocket API.

Parameters:

project_id (int) – Project ID (required)
learn_id (int) – Learn Block ID, use the impulse functions to retrieve the ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

export_keras_block_data(

project_id: StrictInt[StrictInt],

learn_id: StrictInt[StrictInt],

export_keras_block_data_request: ExportKerasBlockDataRequest | None = None,

**kwargs,

) → StartJobResponse[source]#

Export Keras block data

Export the data of a Keras block (already split in train/validate data). Updates are streamed over the websocket API.

Parameters:

project_id (int) – Project ID (required)
learn_id (int) – Learn Block ID, use the impulse functions to retrieve the ID (required)
export_keras_block_data_request (ExportKerasBlockDataRequest) –
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

generate_data_explorer_features(

project_id: StrictInt[StrictInt],

**kwargs,

) → StartJobResponse[source]#

Generate data explorer features

Generate features for the data explorer

Parameters:

project_id (int) – Project ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

generate_features_job(

project_id: StrictInt[StrictInt],

generate_features_request: GenerateFeaturesRequest,

**kwargs,

) → StartJobResponse[source]#

Generate features

Take the raw training set and generate features from them. Updates are streamed over the websocket API.

Parameters:

project_id (int) – Project ID (required)
generate_features_request (GenerateFeaturesRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

get_job_status(

project_id: StrictInt[StrictInt],

job_id: StrictInt[StrictInt],

**kwargs,

) → GetJobResponse[source]#

Get job status

Get the status for a job.

Parameters:

project_id (int) – Project ID (required)
job_id (int) – Job ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetJobResponse

get_jobs_logs(

project_id: StrictInt[StrictInt],

job_id: StrictInt[StrictInt],

limit: StrictInt | None[StrictInt | None] = None,

log_level: StrictStr | None[StrictStr | None] = None,

**kwargs,

) → LogStdoutResponse[source]#

Get logs

Get the logs for a job.

Parameters:

project_id (int) – Project ID (required)
job_id (int) – Job ID (required)
limit (int) – Maximum number of results
log_level (str) – Log level (error, warn, info, debug)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

LogStdoutResponse

get_jobs_summary(

project_id: StrictInt[StrictInt],

start_date: datetime[datetime],

end_date: datetime[datetime],

**kwargs,

) → JobSummaryResponse[source]#

Job summary

Get a summary of jobs, grouped by key. Used to report to users how much compute they’ve used.

Parameters:

project_id (int) – Project ID (required)
start_date (datetime) – Start date (required)
end_date (datetime) – End date (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

JobSummaryResponse

get_profile_tflite_job_result(

project_id: StrictInt[StrictInt],

job_id: StrictInt[StrictInt],

**kwargs,

) → ProfileTfLiteResponse[source]#

Get TFLite profile result (GET)

Get the results from a job started from startProfileTfliteJob (via a GET request).

Parameters:

project_id (int) – Project ID (required)
job_id (int) – Job ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ProfileTfLiteResponse

get_profile_tflite_job_result_via_post_request(

project_id: StrictInt[StrictInt],

job_id: StrictInt[StrictInt],

**kwargs,

) → ProfileTfLiteResponse[source]#

Get TFLite profile result (POST)

Get the results from a job started from startProfileTfliteJob (via a POST request).

Parameters:

project_id (int) – Project ID (required)
job_id (int) – Job ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ProfileTfLiteResponse

list_active_jobs(

project_id: StrictInt[StrictInt],

root_only: StrictBool | None[StrictBool | None] = None,

**kwargs,

) → ListJobsResponse[source]#

List active jobs

Get all active jobs for this project

Parameters:

project_id (int) – Project ID (required)
root_only (bool) – Whether to exclude jobs with a parent ID (so jobs started as part of another job)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ListJobsResponse

List all jobs

Get all jobs for this project

Parameters:

project_id (int) – Project ID (required)
start_date (datetime) – Start date
end_date (datetime) – End date
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
root_only (bool) – Whether to exclude jobs with a parent ID (so jobs started as part of another job)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ListJobsResponse

List finished jobs

Get all finished jobs for this project

Parameters:

project_id (int) – Project ID (required)
start_date (datetime) – Start date
end_date (datetime) – End date
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
root_only (bool) – Whether to exclude jobs with a parent ID (so jobs started as part of another job)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ListJobsResponse

optimize_job(

project_id: StrictInt[StrictInt],

**kwargs,

) → StartJobResponse[source]#

Optimize model

Evaluates optimal model architecture

Parameters:

project_id (int) – Project ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

set_tuner_primary_job(

project_id: StrictInt[StrictInt],

trial_id: StrictStr[StrictStr],

**kwargs,

) → StartJobResponse[source]#

Sets EON tuner primary model

Parameters:

project_id (int) – Project ID (required)
trial_id (str) – trial ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

start_classify_job(

project_id: StrictInt[StrictInt],

**kwargs,

) → StartJobResponse[source]#

Classify

Classifies all items in the testing dataset against the current impulse. Updates are streamed over the websocket API.

Parameters:

project_id (int) – Project ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

start_deploy_pretrained_model_job(

project_id: StrictInt[StrictInt],

deploy_pretrained_model_request: DeployPretrainedModelRequest,

**kwargs,

) → StartJobResponse[source]#

Deploy pretrained model

Takes in a TFLite file and builds the model and SDK. Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed.

Parameters:

project_id (int) – Project ID (required)
deploy_pretrained_model_request (DeployPretrainedModelRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

start_evaluate_job(

project_id: StrictInt[StrictInt],

**kwargs,

) → StartJobResponse[source]#

Evaluate

Evaluates every variant of the current impulse. Updates are streamed over the websocket API.

Parameters:

project_id (int) – Project ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

start_keywords_noise_job(

project_id: StrictInt[StrictInt],

**kwargs,

) → StartJobResponse[source]#

Add keywords and noise

Add keywords and noise data to a project (for getting started guide)

Parameters:

project_id (int) – Project ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

start_make_version_public_job(

project_id: StrictInt[StrictInt],

version_id: StrictInt[StrictInt],

**kwargs,

) → StartJobResponse[source]#

Make a version public

Make a version of a project public. This makes all data and state available (read-only) on a public URL, and allows users to clone this project.

Parameters:

project_id (int) – Project ID (required)
version_id (int) – Version ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

start_original_export_job(

project_id: StrictInt[StrictInt],

export_original_data_request: ExportOriginalDataRequest,

**kwargs,

) → StartJobResponse[source]#

Export original data

Export all the data in the project as it was uploaded to Edge Impulse. Updates are streamed over the websocket API.

Parameters:

project_id (int) – Project ID (required)
export_original_data_request (ExportOriginalDataRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

start_performance_calibration_job(

project_id: StrictInt[StrictInt],

start_performance_calibration_request: StartPerformanceCalibrationRequest,

**kwargs,

) → StartJobResponse[source]#

Performance Calibration

Simulates real world usage and returns performance metrics.

Parameters:

project_id (int) – Project ID (required)
start_performance_calibration_request (StartPerformanceCalibrationRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

start_profile_tflite_job(

project_id: StrictInt[StrictInt],

profile_tf_lite_request: ProfileTfLiteRequest,

**kwargs,

) → StartJobResponse[source]#

Profile TFLite model

Takes in a TFLite model and returns the latency, RAM and ROM used for this model. Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed.

Parameters:

project_id (int) – Project ID (required)
profile_tf_lite_request (ProfileTfLiteRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

start_restore_job(

project_id: StrictInt[StrictInt],

restore_project_request: RestoreProjectRequest,

**kwargs,

) → GenericApiResponse[source]#

Restore project to version

Restore a project to a certain version. This can only applied to a project without data, and will overwrite your impulse and all settings.

Parameters:

project_id (int) – Project ID (required)
restore_project_request (RestoreProjectRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

start_restore_job_from_public(

project_id: StrictInt[StrictInt],

restore_project_from_public_request: RestoreProjectFromPublicRequest,

**kwargs,

) → GenericApiResponse[source]#

Restore project to public version

Restore a project to a certain public version. This can only applied to a project without data, and will overwrite your impulse and all settings.

Parameters:

project_id (int) – Project ID (required)
restore_project_from_public_request (RestoreProjectFromPublicRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

start_retrain_job(

project_id: StrictInt[StrictInt],

**kwargs,

) → StartJobResponse[source]#

Retrain

Retrains the current impulse with the last known parameters. Updates are streamed over the websocket API.

Parameters:

project_id (int) – Project ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

start_version_job(

project_id: StrictInt[StrictInt],

project_version_request: ProjectVersionRequest,

**kwargs,

) → StartJobResponse[source]#

Version project

Create a new version of the project. This stores all data and configuration offsite. If you have access to the enterprise version of Edge Impulse you can store your data in your own storage buckets (only through JWT token authentication).

Parameters:

project_id (int) – Project ID (required)
project_version_request (ProjectVersionRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

start_wav_export_job(

project_id: StrictInt[StrictInt],

export_wav_data_request: ExportWavDataRequest,

**kwargs,

) → StartJobResponse[source]#

Export data as WAV

Export all the data in the project in WAV format. Updates are streamed over the websocket API.

Parameters:

project_id (int) – Project ID (required)
export_wav_data_request (ExportWavDataRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

train_anomaly_job(

project_id: StrictInt[StrictInt],

learn_id: StrictInt[StrictInt],

start_training_request_anomaly: StartTrainingRequestAnomaly,

**kwargs,

) → StartJobResponse[source]#

Train model (Anomaly)

Take the output from a DSP block and train an anomaly detection model using K-means or GMM. Updates are streamed over the websocket API.

Parameters:

project_id (int) – Project ID (required)
learn_id (int) – Learn Block ID, use the impulse functions to retrieve the ID (required)
start_training_request_anomaly (StartTrainingRequestAnomaly) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

train_keras_job(

project_id: StrictInt[StrictInt],

learn_id: StrictInt[StrictInt],

set_keras_parameter_request: SetKerasParameterRequest,

**kwargs,

) → StartJobResponse[source]#

Train model (Keras)

Take the output from a DSP block and train a neural network using Keras. Updates are streamed over the websocket API.

Parameters:

project_id (int) – Project ID (required)
learn_id (int) – Learn Block ID, use the impulse functions to retrieve the ID (required)
set_keras_parameter_request (SetKerasParameterRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse

update_job(

project_id: StrictInt[StrictInt],

job_id: StrictInt[StrictInt],

update_job_request: UpdateJobRequest,

**kwargs,

) → GenericApiResponse[source]#

Update job

Update a job.

Parameters:

project_id (int) – Project ID (required)
job_id (int) – Job ID (required)
update_job_request (UpdateJobRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse