edgeimpulse-api 1.57.2__tar.gz → 1.57.7__tar.gz

{edgeimpulse_api-1.57.2 → edgeimpulse_api-1.57.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edgeimpulse-api
-Version: 1.57.2
+Version: 1.57.7
 Summary: Python bindings for the Edge Impulse API.
 Home-page: https://edgeimpulse.com
 License: Apache-2.0

{edgeimpulse_api-1.57.2 → edgeimpulse_api-1.57.7}/edgeimpulse_api/__init__.py

@@ -14,7 +14,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "1.57.2" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
+__version__ = "1.57.7" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
 
 # import apis into sdk package
 from edgeimpulse_api.api.classify_api import ClassifyApi
@@ -144,6 +144,9 @@ from edgeimpulse_api.models.admin_update_trial_request import AdminUpdateTrialRe
 from edgeimpulse_api.models.admin_update_user_permissions_request import AdminUpdateUserPermissionsRequest
 from edgeimpulse_api.models.admin_update_user_request import AdminUpdateUserRequest
 from edgeimpulse_api.models.akida_edge_learning_config import AkidaEdgeLearningConfig
+from edgeimpulse_api.models.all_learn_blocks_response import AllLearnBlocksResponse
+from edgeimpulse_api.models.all_learn_blocks_response_all_of import AllLearnBlocksResponseAllOf
+from edgeimpulse_api.models.all_learn_blocks_response_all_of_learn_blocks import AllLearnBlocksResponseAllOfLearnBlocks
 from edgeimpulse_api.models.anomaly_capacity import AnomalyCapacity
 from edgeimpulse_api.models.anomaly_config import AnomalyConfig
 from edgeimpulse_api.models.anomaly_config_axes_inner import AnomalyConfigAxesInner
@@ -682,6 +685,7 @@ from edgeimpulse_api.models.object_detection_last_layer import ObjectDetectionLa
 from edgeimpulse_api.models.optimize_config import OptimizeConfig
 from edgeimpulse_api.models.optimize_config_response import OptimizeConfigResponse
 from edgeimpulse_api.models.optimize_config_response_all_of import OptimizeConfigResponseAllOf
+from edgeimpulse_api.models.optimize_config_search_space_template import OptimizeConfigSearchSpaceTemplate
 from edgeimpulse_api.models.optimize_config_target_device import OptimizeConfigTargetDevice
 from edgeimpulse_api.models.optimize_dsp_parameters_response import OptimizeDSPParametersResponse
 from edgeimpulse_api.models.optimize_dsp_parameters_response_all_of import OptimizeDSPParametersResponseAllOf
@@ -932,6 +936,8 @@ from edgeimpulse_api.models.tuner_trial_blocks_inner import TunerTrialBlocksInne
 from edgeimpulse_api.models.tuner_trial_dsp_job_id import TunerTrialDspJobId
 from edgeimpulse_api.models.tuner_trial_impulse import TunerTrialImpulse
 from edgeimpulse_api.models.tuner_trial_impulse_added_to_project import TunerTrialImpulseAddedToProject
+from edgeimpulse_api.models.tuner_trial_metrics import TunerTrialMetrics
+from edgeimpulse_api.models.tuner_trial_metrics_test import TunerTrialMetricsTest
 from edgeimpulse_api.models.update_impulse_request import UpdateImpulseRequest
 from edgeimpulse_api.models.update_job_request import UpdateJobRequest
 from edgeimpulse_api.models.update_organization_add_collaborator_request import UpdateOrganizationAddCollaboratorRequest
@@ -1002,6 +1008,6 @@ from edgeimpulse_api.models.whitelabel import Whitelabel
 from edgeimpulse_api.models.whitelabel_admin_create_organization_request import WhitelabelAdminCreateOrganizationRequest
 from edgeimpulse_api.models.whitelabel_all_learning_blocks_inner import WhitelabelAllLearningBlocksInner
 from edgeimpulse_api.models.whitelabel_custom_deployment_blocks_inner import WhitelabelCustomDeploymentBlocksInner
+from edgeimpulse_api.models.window_settings import WindowSettings
 from edgeimpulse_api.models.window_settings_response import WindowSettingsResponse
 from edgeimpulse_api.models.window_settings_response_all_of import WindowSettingsResponseAllOf
-from edgeimpulse_api.models.window_settings_response_all_of_window_settings import WindowSettingsResponseAllOfWindowSettings

{edgeimpulse_api-1.57.2 → edgeimpulse_api-1.57.7}/edgeimpulse_api/api/optimization_api.py

@@ -19,6 +19,7 @@ from typing_extensions import Annotated
 
 from pydantic import Field, StrictInt, StrictStr
 
+from edgeimpulse_api.models.all_learn_blocks_response import AllLearnBlocksResponse
 from edgeimpulse_api.models.generic_api_response import GenericApiResponse
 from edgeimpulse_api.models.list_tuner_runs_response import ListTunerRunsResponse
 from edgeimpulse_api.models.log_stdout_response import LogStdoutResponse
@@ -333,6 +334,139 @@ class OptimizationApi(object):
             collection_formats=_collection_formats,
             _request_auth=_params.get('_request_auth'))
 
+    @validate_arguments
+    def get_all_learn_blocks(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], **kwargs) -> AllLearnBlocksResponse:  # noqa: E501
+        """Get all available learn blocks
+
+        Get all available learn blocks
+
+        :param project_id: Project ID (required)
+        :type project_id: int
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :type _preload_content: bool, optional
+        :param _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.
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: AllLearnBlocksResponse
+        """
+        kwargs['_return_http_data_only'] = True
+        return self._get_all_learn_blocks_with_http_info(project_id, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def _get_all_learn_blocks_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], **kwargs):  # noqa: E501
+        """Get all available learn blocks 
+
+        Get all available learn blocks
+
+        :param project_id: Project ID (required)
+        :type project_id: int
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _return_http_data_only: response data without head status code
+                                       and headers
+        :type _return_http_data_only: bool, optional
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :type _preload_content: bool, optional
+        :param _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.
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(AllLearnBlocksResponse, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'project_id'
+        ]
+        _all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth',
+                '_content_type',
+                '_headers'
+            ]
+        )
+
+        # validate the arguments
+        for _key, _val in _params['kwargs'].items():
+            if _key not in _all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_all_learn_blocks" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+        if _params['project_id']:
+            _path_params['projectId'] = _params['project_id']
+
+        # process the query parameters
+        _query_params = []
+
+        # process the header parameters
+        _header_params = dict(_params.get('_headers', {}))
+
+        # process the form parameters
+        _form_params = []
+        _files = {}
+
+        # process the body parameter
+        _body_params = None
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # authentication setting
+        _auth_settings = ['ApiKeyAuthentication', 'JWTAuthentication', 'JWTHttpHeaderAuthentication']  # noqa: E501
+
+        _response_types_map = {
+            '200': "AllLearnBlocksResponse",
+        }
+
+        return self.api_client.call_api(
+            '/api/{projectId}/optimize/all-learn-blocks', 'GET',
+            _path_params,
+            _query_params,
+            _header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            response_types_map=_response_types_map,
+            auth_settings=_auth_settings,
+            async_req=_params.get('async_req'),
+            _return_http_data_only=_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=_params.get('_preload_content', True),
+            _request_timeout=_params.get('_request_timeout'),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get('_request_auth'))
+
     @validate_arguments
     def get_config(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], **kwargs) -> OptimizeConfigResponse:  # noqa: E501
         """Get config

edgeimpulse_api-1.57.7/edgeimpulse_api/generated_from_hash.txt

@@ -0,0 +1 @@
+095bcfa8c3bf35fee95f43202415129b84b982f7

{edgeimpulse_api-1.57.2 → edgeimpulse_api-1.57.7}/edgeimpulse_api/models/__init__.py

@@ -106,6 +106,9 @@ from edgeimpulse_api.models.admin_update_trial_request import AdminUpdateTrialRe
 from edgeimpulse_api.models.admin_update_user_permissions_request import AdminUpdateUserPermissionsRequest
 from edgeimpulse_api.models.admin_update_user_request import AdminUpdateUserRequest
 from edgeimpulse_api.models.akida_edge_learning_config import AkidaEdgeLearningConfig
+from edgeimpulse_api.models.all_learn_blocks_response import AllLearnBlocksResponse
+from edgeimpulse_api.models.all_learn_blocks_response_all_of import AllLearnBlocksResponseAllOf
+from edgeimpulse_api.models.all_learn_blocks_response_all_of_learn_blocks import AllLearnBlocksResponseAllOfLearnBlocks
 from edgeimpulse_api.models.anomaly_capacity import AnomalyCapacity
 from edgeimpulse_api.models.anomaly_config import AnomalyConfig
 from edgeimpulse_api.models.anomaly_config_axes_inner import AnomalyConfigAxesInner
@@ -644,6 +647,7 @@ from edgeimpulse_api.models.object_detection_last_layer import ObjectDetectionLa
 from edgeimpulse_api.models.optimize_config import OptimizeConfig
 from edgeimpulse_api.models.optimize_config_response import OptimizeConfigResponse
 from edgeimpulse_api.models.optimize_config_response_all_of import OptimizeConfigResponseAllOf
+from edgeimpulse_api.models.optimize_config_search_space_template import OptimizeConfigSearchSpaceTemplate
 from edgeimpulse_api.models.optimize_config_target_device import OptimizeConfigTargetDevice
 from edgeimpulse_api.models.optimize_dsp_parameters_response import OptimizeDSPParametersResponse
 from edgeimpulse_api.models.optimize_dsp_parameters_response_all_of import OptimizeDSPParametersResponseAllOf
@@ -894,6 +898,8 @@ from edgeimpulse_api.models.tuner_trial_blocks_inner import TunerTrialBlocksInne
 from edgeimpulse_api.models.tuner_trial_dsp_job_id import TunerTrialDspJobId
 from edgeimpulse_api.models.tuner_trial_impulse import TunerTrialImpulse
 from edgeimpulse_api.models.tuner_trial_impulse_added_to_project import TunerTrialImpulseAddedToProject
+from edgeimpulse_api.models.tuner_trial_metrics import TunerTrialMetrics
+from edgeimpulse_api.models.tuner_trial_metrics_test import TunerTrialMetricsTest
 from edgeimpulse_api.models.update_impulse_request import UpdateImpulseRequest
 from edgeimpulse_api.models.update_job_request import UpdateJobRequest
 from edgeimpulse_api.models.update_organization_add_collaborator_request import UpdateOrganizationAddCollaboratorRequest
@@ -964,6 +970,6 @@ from edgeimpulse_api.models.whitelabel import Whitelabel
 from edgeimpulse_api.models.whitelabel_admin_create_organization_request import WhitelabelAdminCreateOrganizationRequest
 from edgeimpulse_api.models.whitelabel_all_learning_blocks_inner import WhitelabelAllLearningBlocksInner
 from edgeimpulse_api.models.whitelabel_custom_deployment_blocks_inner import WhitelabelCustomDeploymentBlocksInner
+from edgeimpulse_api.models.window_settings import WindowSettings
 from edgeimpulse_api.models.window_settings_response import WindowSettingsResponse
 from edgeimpulse_api.models.window_settings_response_all_of import WindowSettingsResponseAllOf
-from edgeimpulse_api.models.window_settings_response_all_of_window_settings import WindowSettingsResponseAllOfWindowSettings

edgeimpulse_api-1.57.7/edgeimpulse_api/models/all_learn_blocks_response.py

@@ -0,0 +1,77 @@
+# coding: utf-8
+
+"""
+    Edge Impulse API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import List, Optional
+from pydantic import BaseModel, Field, StrictBool, StrictStr
+from edgeimpulse_api.models.all_learn_blocks_response_all_of_learn_blocks import AllLearnBlocksResponseAllOfLearnBlocks
+
+class AllLearnBlocksResponse(BaseModel):
+    success: StrictBool = Field(..., description="Whether the operation succeeded")
+    error: Optional[StrictStr] = Field(None, description="Optional error description (set if 'success' was false)")
+    learn_blocks: List[AllLearnBlocksResponseAllOfLearnBlocks] = Field(..., alias="learnBlocks")
+    __properties = ["success", "error", "learnBlocks"]
+
+    class Config:
+        allow_population_by_field_name = True
+        validate_assignment = False
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> AllLearnBlocksResponse:
+        """Create an instance of AllLearnBlocksResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each item in learn_blocks (list)
+        _items = []
+        if self.learn_blocks:
+            for _item in self.learn_blocks:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['learnBlocks'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> AllLearnBlocksResponse:
+        """Create an instance of AllLearnBlocksResponse from a dict"""
+        if obj is None:
+            return None
+
+        if type(obj) is not dict:
+            return AllLearnBlocksResponse.construct(**obj)
+
+        _obj = AllLearnBlocksResponse.construct(**{
+            "success": obj.get("success"),
+            "error": obj.get("error"),
+            "learn_blocks": [AllLearnBlocksResponseAllOfLearnBlocks.from_dict(_item) for _item in obj.get("learnBlocks")] if obj.get("learnBlocks") is not None else None
+        })
+        return _obj
+

edgeimpulse_api-1.57.7/edgeimpulse_api/models/all_learn_blocks_response_all_of.py

@@ -0,0 +1,73 @@
+# coding: utf-8
+
+"""
+    Edge Impulse API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import List
+from pydantic import BaseModel, Field
+from edgeimpulse_api.models.all_learn_blocks_response_all_of_learn_blocks import AllLearnBlocksResponseAllOfLearnBlocks
+
+class AllLearnBlocksResponseAllOf(BaseModel):
+    learn_blocks: List[AllLearnBlocksResponseAllOfLearnBlocks] = Field(..., alias="learnBlocks")
+    __properties = ["learnBlocks"]
+
+    class Config:
+        allow_population_by_field_name = True
+        validate_assignment = False
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> AllLearnBlocksResponseAllOf:
+        """Create an instance of AllLearnBlocksResponseAllOf from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each item in learn_blocks (list)
+        _items = []
+        if self.learn_blocks:
+            for _item in self.learn_blocks:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['learnBlocks'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> AllLearnBlocksResponseAllOf:
+        """Create an instance of AllLearnBlocksResponseAllOf from a dict"""
+        if obj is None:
+            return None
+
+        if type(obj) is not dict:
+            return AllLearnBlocksResponseAllOf.construct(**obj)
+
+        _obj = AllLearnBlocksResponseAllOf.construct(**{
+            "learn_blocks": [AllLearnBlocksResponseAllOfLearnBlocks.from_dict(_item) for _item in obj.get("learnBlocks")] if obj.get("learnBlocks") is not None else None
+        })
+        return _obj
+

edgeimpulse_api-1.57.7/edgeimpulse_api/models/all_learn_blocks_response_all_of_learn_blocks.py

@@ -0,0 +1,84 @@
+# coding: utf-8
+
+"""
+    Edge Impulse API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Optional
+from pydantic import BaseModel, Field, StrictStr
+from edgeimpulse_api.models.block_display_category import BlockDisplayCategory
+from edgeimpulse_api.models.learn_block_type import LearnBlockType
+from edgeimpulse_api.models.public_project_tier_availability import PublicProjectTierAvailability
+
+class AllLearnBlocksResponseAllOfLearnBlocks(BaseModel):
+    type: LearnBlockType = ...
+    title: StrictStr = ...
+    author: StrictStr = ...
+    description: StrictStr = ...
+    name: StrictStr = ...
+    organization_model_id: Optional[float] = Field(None, alias="organizationModelId")
+    experiment: Optional[StrictStr] = None
+    display_category: Optional[BlockDisplayCategory] = Field(None, alias="displayCategory")
+    public_project_tier_availability: Optional[PublicProjectTierAvailability] = Field(None, alias="publicProjectTierAvailability")
+    __properties = ["type", "title", "author", "description", "name", "organizationModelId", "experiment", "displayCategory", "publicProjectTierAvailability"]
+
+    class Config:
+        allow_population_by_field_name = True
+        validate_assignment = False
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> AllLearnBlocksResponseAllOfLearnBlocks:
+        """Create an instance of AllLearnBlocksResponseAllOfLearnBlocks from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> AllLearnBlocksResponseAllOfLearnBlocks:
+        """Create an instance of AllLearnBlocksResponseAllOfLearnBlocks from a dict"""
+        if obj is None:
+            return None
+
+        if type(obj) is not dict:
+            return AllLearnBlocksResponseAllOfLearnBlocks.construct(**obj)
+
+        _obj = AllLearnBlocksResponseAllOfLearnBlocks.construct(**{
+            "type": obj.get("type"),
+            "title": obj.get("title"),
+            "author": obj.get("author"),
+            "description": obj.get("description"),
+            "name": obj.get("name"),
+            "organization_model_id": obj.get("organizationModelId"),
+            "experiment": obj.get("experiment"),
+            "display_category": obj.get("displayCategory"),
+            "public_project_tier_availability": obj.get("publicProjectTierAvailability")
+        })
+        return _obj
+

{edgeimpulse_api-1.57.2 → edgeimpulse_api-1.57.7}/edgeimpulse_api/models/classify_sample_response_classification.py

@@ -29,7 +29,7 @@ from edgeimpulse_api.models.structured_label import StructuredLabel
 class ClassifySampleResponseClassification(BaseModel):
     learn_block: ImpulseLearnBlock = Field(..., alias="learnBlock")
     result: List[Dict[str, float]] = Field(..., description="Classification result, one item per window.")
-    anomaly_result: Optional[List[AnomalyResult]] = Field(None, alias="anomalyResult", description="Anomaly scores and computed metrics for GMM anomaly detection, one item per window.")
+    anomaly_result: Optional[List[AnomalyResult]] = Field(None, alias="anomalyResult", description="Anomaly scores and computed metrics for visual anomaly detection, one item per window.")
     structured_result: Optional[List[StructuredClassifyResult]] = Field(None, alias="structuredResult", description="Results of inferencing that returns structured data, such as object detection")
     minimum_confidence_rating: float = Field(..., alias="minimumConfidenceRating", description="The minimum confidence rating for this block. For regression, this is the absolute error (which can be larger than 1).")
     details: Optional[List[ClassifySampleResponseClassificationDetails]] = Field(None, description="Structured outputs and computed metrics for some model types (e.g. object detection), one item per window.")

{edgeimpulse_api-1.57.2 → edgeimpulse_api-1.57.7}/edgeimpulse_api/models/model_prediction.py

@@ -28,7 +28,7 @@ class ModelPrediction(BaseModel):
     prediction: StrictStr = ...
     prediction_correct: Optional[StrictBool] = Field(None, alias="predictionCorrect")
     f1_score: Optional[float] = Field(None, alias="f1Score", description="Only set for object detection projects")
-    anomaly_scores: Optional[List[List[float]]] = Field(None, alias="anomalyScores", description="Only set for visual anomaly projects. 2D array of shape (n, n) with raw anomaly scores, where n can be calculated as ((1/8 of image input size)/2 - 1). The scores corresponds to each grid cell in the image's spatial matrix.")
+    anomaly_scores: Optional[List[List[float]]] = Field(None, alias="anomalyScores", description="Only set for visual anomaly projects. 2D array of shape (n, n) with raw anomaly scores, where n varies based on the image input size and the specific visual anomaly algorithm used. The scores corresponds to each grid cell in the image's spatial matrix.")
     __properties = ["sampleId", "startMs", "endMs", "label", "prediction", "predictionCorrect", "f1Score", "anomalyScores"]
 
     class Config:

{edgeimpulse_api-1.57.2 → edgeimpulse_api-1.57.7}/edgeimpulse_api/models/optimize_config.py

@@ -19,13 +19,12 @@ import json
 
 from typing import Dict, List, Optional
 from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, validator
+from edgeimpulse_api.models.optimize_config_search_space_template import OptimizeConfigSearchSpaceTemplate
 from edgeimpulse_api.models.optimize_config_target_device import OptimizeConfigTargetDevice
 from edgeimpulse_api.models.tuner_space_impulse import TunerSpaceImpulse
 
 class OptimizeConfig(BaseModel):
     name: Optional[StrictStr] = None
-    dataset_category: StrictStr = Field(..., alias="datasetCategory", description="Dataset category")
-    classification_type: StrictStr = Field(..., alias="classificationType", description="Classification type")
     target_latency: StrictInt = Field(..., alias="targetLatency", description="Target latency in MS")
     target_device: OptimizeConfigTargetDevice = Field(..., alias="targetDevice")
     compiler: Optional[List[StrictStr]] = None
@@ -39,19 +38,8 @@ class OptimizeConfig(BaseModel):
     notification_on_completion: Optional[StrictBool] = Field(None, alias="notificationOnCompletion")
     tuner_space_options: Optional[Dict[str, List[StrictStr]]] = Field(None, alias="tunerSpaceOptions")
     space: Optional[List[TunerSpaceImpulse]] = Field(None, description="List of impulses specifying the EON Tuner search space")
-    __properties = ["name", "datasetCategory", "classificationType", "targetLatency", "targetDevice", "compiler", "precision", "trainingCycles", "tuningMaxTrials", "tuningWorkers", "minMACCS", "maxMACCS", "tuningAlgorithm", "notificationOnCompletion", "tunerSpaceOptions", "space"]
-
-    @validator('dataset_category')
-    def dataset_category_validate_enum(cls, v):
-        if v not in ('speech_keyword', 'speech_continuous', 'audio_event', 'audio_continuous', 'transfer_learning', 'motion_event', 'motion_continuous', 'audio_syntiant', 'object_detection_bounding_boxes', 'object_detection_centroids', 'visual_ad'):
-            raise ValueError("must validate the enum values ('speech_keyword', 'speech_continuous', 'audio_event', 'audio_continuous', 'transfer_learning', 'motion_event', 'motion_continuous', 'audio_syntiant', 'object_detection_bounding_boxes', 'object_detection_centroids', 'visual_ad')")
-        return v
-
-    @validator('classification_type')
-    def classification_type_validate_enum(cls, v):
-        if v not in ('classification', 'regression', 'anomaly', 'object_detection'):
-            raise ValueError("must validate the enum values ('classification', 'regression', 'anomaly', 'object_detection')")
-        return v
+    search_space_template: Optional[OptimizeConfigSearchSpaceTemplate] = Field(None, alias="searchSpaceTemplate")
+    __properties = ["name", "targetLatency", "targetDevice", "compiler", "precision", "trainingCycles", "tuningMaxTrials", "tuningWorkers", "minMACCS", "maxMACCS", "tuningAlgorithm", "notificationOnCompletion", "tunerSpaceOptions", "space", "searchSpaceTemplate"]
 
     @validator('tuning_algorithm')
     def tuning_algorithm_validate_enum(cls, v):
@@ -95,6 +83,9 @@ class OptimizeConfig(BaseModel):
                 if _item:
                     _items.append(_item.to_dict())
             _dict['space'] = _items
+        # override the default output from pydantic by calling `to_dict()` of search_space_template
+        if self.search_space_template:
+            _dict['searchSpaceTemplate'] = self.search_space_template.to_dict()
         return _dict
 
     @classmethod
@@ -108,8 +99,6 @@ class OptimizeConfig(BaseModel):
 
         _obj = OptimizeConfig.construct(**{
             "name": obj.get("name"),
-            "dataset_category": obj.get("datasetCategory"),
-            "classification_type": obj.get("classificationType"),
             "target_latency": obj.get("targetLatency"),
             "target_device": OptimizeConfigTargetDevice.from_dict(obj.get("targetDevice")) if obj.get("targetDevice") is not None else None,
             "compiler": obj.get("compiler"),
@@ -122,7 +111,8 @@ class OptimizeConfig(BaseModel):
             "tuning_algorithm": obj.get("tuningAlgorithm"),
             "notification_on_completion": obj.get("notificationOnCompletion"),
             "tuner_space_options": obj.get("tunerSpaceOptions"),
-            "space": [TunerSpaceImpulse.from_dict(_item) for _item in obj.get("space")] if obj.get("space") is not None else None
+            "space": [TunerSpaceImpulse.from_dict(_item) for _item in obj.get("space")] if obj.get("space") is not None else None,
+            "search_space_template": OptimizeConfigSearchSpaceTemplate.from_dict(obj.get("searchSpaceTemplate")) if obj.get("searchSpaceTemplate") is not None else None
         })
         return _obj
 

{edgeimpulse_api-1.57.2 → edgeimpulse_api-1.57.7}/edgeimpulse_api/models/optimize_config_response.py

@@ -19,6 +19,7 @@ import json
 
 from typing import Any, Dict, List, Optional
 from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, validator
+from edgeimpulse_api.models.optimize_config_search_space_template import OptimizeConfigSearchSpaceTemplate
 from edgeimpulse_api.models.optimize_config_target_device import OptimizeConfigTargetDevice
 from edgeimpulse_api.models.tuner_space_impulse import TunerSpaceImpulse
 
@@ -26,8 +27,6 @@ class OptimizeConfigResponse(BaseModel):
     success: StrictBool = Field(..., description="Whether the operation succeeded")
     error: Optional[StrictStr] = Field(None, description="Optional error description (set if 'success' was false)")
     name: Optional[StrictStr] = None
-    dataset_category: StrictStr = Field(..., alias="datasetCategory", description="Dataset category")
-    classification_type: StrictStr = Field(..., alias="classificationType", description="Classification type")
     target_latency: StrictInt = Field(..., alias="targetLatency", description="Target latency in MS")
     target_device: OptimizeConfigTargetDevice = Field(..., alias="targetDevice")
     compiler: Optional[List[StrictStr]] = None
@@ -41,20 +40,9 @@ class OptimizeConfigResponse(BaseModel):
     notification_on_completion: Optional[StrictBool] = Field(None, alias="notificationOnCompletion")
     tuner_space_options: Optional[Dict[str, List[StrictStr]]] = Field(None, alias="tunerSpaceOptions")
     space: Optional[List[TunerSpaceImpulse]] = Field(None, description="List of impulses specifying the EON Tuner search space")
+    search_space_template: Optional[OptimizeConfigSearchSpaceTemplate] = Field(None, alias="searchSpaceTemplate")
     device: Optional[Dict[str, Any]] = None
-    __properties = ["success", "error", "name", "datasetCategory", "classificationType", "targetLatency", "targetDevice", "compiler", "precision", "trainingCycles", "tuningMaxTrials", "tuningWorkers", "minMACCS", "maxMACCS", "tuningAlgorithm", "notificationOnCompletion", "tunerSpaceOptions", "space", "device"]
-
-    @validator('dataset_category')
-    def dataset_category_validate_enum(cls, v):
-        if v not in ('speech_keyword', 'speech_continuous', 'audio_event', 'audio_continuous', 'transfer_learning', 'motion_event', 'motion_continuous', 'audio_syntiant', 'object_detection_bounding_boxes', 'object_detection_centroids', 'visual_ad'):
-            raise ValueError("must validate the enum values ('speech_keyword', 'speech_continuous', 'audio_event', 'audio_continuous', 'transfer_learning', 'motion_event', 'motion_continuous', 'audio_syntiant', 'object_detection_bounding_boxes', 'object_detection_centroids', 'visual_ad')")
-        return v
-
-    @validator('classification_type')
-    def classification_type_validate_enum(cls, v):
-        if v not in ('classification', 'regression', 'anomaly', 'object_detection'):
-            raise ValueError("must validate the enum values ('classification', 'regression', 'anomaly', 'object_detection')")
-        return v
+    __properties = ["success", "error", "name", "targetLatency", "targetDevice", "compiler", "precision", "trainingCycles", "tuningMaxTrials", "tuningWorkers", "minMACCS", "maxMACCS", "tuningAlgorithm", "notificationOnCompletion", "tunerSpaceOptions", "space", "searchSpaceTemplate", "device"]
 
     @validator('tuning_algorithm')
     def tuning_algorithm_validate_enum(cls, v):
@@ -98,6 +86,9 @@ class OptimizeConfigResponse(BaseModel):
                 if _item:
                     _items.append(_item.to_dict())
             _dict['space'] = _items
+        # override the default output from pydantic by calling `to_dict()` of search_space_template
+        if self.search_space_template:
+            _dict['searchSpaceTemplate'] = self.search_space_template.to_dict()
         return _dict
 
     @classmethod
@@ -113,8 +104,6 @@ class OptimizeConfigResponse(BaseModel):
             "success": obj.get("success"),
             "error": obj.get("error"),
             "name": obj.get("name"),
-            "dataset_category": obj.get("datasetCategory"),
-            "classification_type": obj.get("classificationType"),
             "target_latency": obj.get("targetLatency"),
             "target_device": OptimizeConfigTargetDevice.from_dict(obj.get("targetDevice")) if obj.get("targetDevice") is not None else None,
             "compiler": obj.get("compiler"),
@@ -128,6 +117,7 @@ class OptimizeConfigResponse(BaseModel):
             "notification_on_completion": obj.get("notificationOnCompletion"),
             "tuner_space_options": obj.get("tunerSpaceOptions"),
             "space": [TunerSpaceImpulse.from_dict(_item) for _item in obj.get("space")] if obj.get("space") is not None else None,
+            "search_space_template": OptimizeConfigSearchSpaceTemplate.from_dict(obj.get("searchSpaceTemplate")) if obj.get("searchSpaceTemplate") is not None else None,
             "device": obj.get("device")
         })
         return _obj