Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.edgeimpulse.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Classes

​
EdgeImpulseException

edgeimpulse.exceptions.EdgeImpulseException(
	message
)
Common base class for all non-exit exceptions.
Parameters
message
Bases
builtins.Exception
builtins.BaseException
Classes
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

edgeimpulse.exceptions.InvalidAuthTypeException(
	message
)
Common base class for all non-exit exceptions.
Parameters
message
Bases
edgeimpulse.exceptions.EdgeImpulseException
builtins.Exception
builtins.BaseException

​
InvalidDeployParameterException

edgeimpulse.exceptions.InvalidDeployParameterException(
	msg: str
)
Exception raised when an invalid parameter is passed.
Parameters
msgstr
Bases
edgeimpulse.exceptions.EdgeImpulseException
builtins.Exception
builtins.BaseException

​
InvalidDeviceException

edgeimpulse.exceptions.InvalidDeviceException(
	device: str,
	profile_devices: List[str]
)
Exception raised when an invalid device is passed.
Parameters
devicestr
profile_devicesList[str]
Bases
edgeimpulse.exceptions.EdgeImpulseException
builtins.Exception
builtins.BaseException

​
InvalidEngineException

edgeimpulse.exceptions.InvalidEngineException(
	validation_error
)
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

edgeimpulse.exceptions.InvalidModelException(
	msg: str
)
Common base class for all non-exit exceptions.
Parameters
msgstr
Bases
edgeimpulse.exceptions.EdgeImpulseException
builtins.Exception
builtins.BaseException

​
InvalidTargetException

edgeimpulse.exceptions.InvalidTargetException(
	deploy_target: str,
	target_names: List[str]
)
Exception raised when an invalid target is passed. For a list of valid targets use edgeimpulse.model.list_deployment_targets().
Parameters
deploy_targetstr
target_namesList[str]
Bases
edgeimpulse.exceptions.EdgeImpulseException
builtins.Exception
builtins.BaseException

​
MissingApiIngestionEndpointException

edgeimpulse.exceptions.MissingApiIngestionEndpointException(
	
)
Common base class for all non-exit exceptions.
Bases
edgeimpulse.exceptions.EdgeImpulseException
builtins.Exception
builtins.BaseException

​
MissingApiKeyException

edgeimpulse.exceptions.MissingApiKeyException(
	
)
Common base class for all non-exit exceptions.
Bases
edgeimpulse.exceptions.EdgeImpulseException
builtins.Exception
builtins.BaseException

​
TimeoutException

edgeimpulse.exceptions.TimeoutException(
	msg: str
)
Exception raised when a timeout has been reached.
Parameters
msgstr
Bases
edgeimpulse.exceptions.EdgeImpulseException
builtins.Exception
builtins.BaseException

​
UnsuccessfulRequestException

edgeimpulse.exceptions.UnsuccessfulRequestException(
	error: str | None
)
Common base class for all non-exit exceptions.
Parameters
errorstr | None
Bases
edgeimpulse.exceptions.EdgeImpulseException
builtins.Exception
builtins.BaseException

​
UnsupportedSampleType

edgeimpulse.exceptions.UnsupportedSampleType(
	error: str | None
)
Exception raised when attempting to upload or download a data type that is not supported by Edge Impulse.
Parameters
errorstr | None
Bases
edgeimpulse.exceptions.EdgeImpulseException
builtins.Exception
builtins.BaseException