jobs_api module

JobsApi

class edgeimpulse_api.api.jobs_api.JobsApi(
		api_client=None
)

Parameters

  • api_client=None

Methods

autotune_dsp_job

edgeimpulse_api.api.jobs_api.autotune_dsp_job(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		autotune_dsp_request: edgeimpulse_api.models.autotune_dsp_request.AutotuneDspRequest,
		**kwargs
)> edgeimpulse_api.models.start_job_response.StartJobResponse

Autotune DSP parameters

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

Parameters

  • self

  • project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

  • autotune_dsp_request: edgeimpulse_api.models.autotune_dsp_request.AutotuneDspRequest

  • **kwargs

Return

edgeimpulse_api.models.start_job_response.StartJobResponse

build_on_device_model_job

edgeimpulse_api.api.jobs_api.build_on_device_model_job(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		type: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='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.', extra={})],
		build_on_device_model_request: edgeimpulse_api.models.build_on_device_model_request.BuildOnDeviceModelRequest,
		**kwargs
)> edgeimpulse_api.models.start_job_response.StartJobResponse

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

  • self

  • project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

  • type: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='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.', extra={})]

  • build_on_device_model_request: edgeimpulse_api.models.build_on_device_model_request.BuildOnDeviceModelRequest

  • **kwargs

Return

edgeimpulse_api.models.start_job_response.StartJobResponse

build_organization_on_device_model_job

edgeimpulse_api.api.jobs_api.build_organization_on_device_model_job(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		build_organization_on_device_model_request: edgeimpulse_api.models.build_organization_on_device_model_request.BuildOrganizationOnDeviceModelRequest,
		**kwargs
)> edgeimpulse_api.models.start_job_response.StartJobResponse

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

  • self

  • project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

  • build_organization_on_device_model_request: edgeimpulse_api.models.build_organization_on_device_model_request.BuildOrganizationOnDeviceModelRequest

  • **kwargs

Return

edgeimpulse_api.models.start_job_response.StartJobResponse

calculate_data_quality_metrics

edgeimpulse_api.api.jobs_api.calculate_data_quality_metrics(