deployment_api module

DeploymentApi

class edgeimpulse_api.api.deployment_api.DeploymentApi(
		api_client=None
)

Parameters

  • api_client=None

Methods

download_build

edgeimpulse_api.api.deployment_api.download_build(
		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={})],
		model_type: typing_extensions.Annotated[Optional[edgeimpulse_api.models.keras_model_type_enum.KerasModelTypeEnum], FieldInfo(default=PydanticUndefined, description='Optional model type of the build (if not, it uses the settings in the Keras block)', extra={})] = None,
		engine: typing_extensions.Annotated[Optional[edgeimpulse_api.models.deployment_target_engine.DeploymentTargetEngine], FieldInfo(default=PydanticUndefined, description='Optional engine for the build (if not, it uses the default engine for the deployment target)', extra={})] = None,
		**kwargs
)> str

Download

Download the build artefacts for a project

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={})]

  • model_type: typing_extensions.Annotated[Optional[edgeimpulse_api.models.keras_model_type_enum.KerasModelTypeEnum], FieldInfo(default=PydanticUndefined, description='Optional model type of the build (if not, it uses the settings in the Keras block)', extra={})] = None

  • engine: typing_extensions.Annotated[Optional[edgeimpulse_api.models.deployment_target_engine.DeploymentTargetEngine], FieldInfo(default=PydanticUndefined, description='Optional engine for the build (if not, it uses the default engine for the deployment target)', extra={})] = None

  • **kwargs

Return

str

find_syntiant_posterior

edgeimpulse_api.api.deployment_api.find_syntiant_posterior(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		target_words: List[pydantic.types.StrictStr],
		reference_set: pydantic.types.StrictStr,
		wav_file: Optional[pydantic.types.StrictStr] = None,
		meta_csv_file: Optional[pydantic.types.StrictStr] = None,
		deployment_target: Optional[pydantic.types.StrictStr] = None,
		**kwargs
)> edgeimpulse_api.models.start_job_response.StartJobResponse

Find Syntiant posterior parameters

Automatically find the current posterior parameters for the Syntiant deployment target

Parameters

  • self

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

  • target_words: List[pydantic.types.StrictStr]

  • reference_set: pydantic.types.StrictStr

  • wav_file: Optional[pydantic.types.StrictStr] = None

  • meta_csv_file: Optional[pydantic.types.StrictStr] = None

  • deployment_target: Optional[pydantic.types.StrictStr] = None

  • **kwargs

Return

edgeimpulse_api.models.start_job_response.StartJobResponse

get_deployment

edgeimpulse_api.api.deployment_api.get_deployment(
		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={})],