optimization_api

edgeimpulse_api v1.0.0

edgeimpulse_api.api.optimization_api module

class edgeimpulse_api.api.optimization_api.OptimizationApi(api_client=None)

Bases: object

create_trial(project_id: StrictInt, job_id: StrictInt, tuner_create_trial_impulse: TunerCreateTrialImpulse, **kwargs)

Create trial

Create trial

• Parameters

  • project_id (int) – Project ID (required)

  • job_id (int) – Job ID (required)

  • tuner_create_trial_impulse (TunerCreateTrialImpulse) – (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

delete_state(project_id: StrictInt, **kwargs)

Delete EON tuner state

Completely clears the EON tuner state for this project.

• 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

  GenericApiResponse

get_config(project_id: StrictInt, **kwargs)

Get config

Get config

• 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

  OptimizeConfigResponse

get_dsp_parameters(project_id: StrictInt, organization_id: StrictInt, organization_dsp_id: StrictInt, **kwargs)

Retrieves DSP block parameters

Retrieves DSP block parameters

• Parameters

  • project_id (int) – Project ID (required)

  • organization_id (int) – Organization ID (required)

  • organization_dsp_id (int) – Organization DSP 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

  OptimizeDSPParametersResponse

get_space(project_id: StrictInt, **kwargs)

Search space

Search space

• 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

  OptimizeSpaceResponse

get_state(project_id: StrictInt, **kwargs)

Retrieves the EON tuner state

Retrieves the EON tuner state

• 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

  OptimizeStateResponse

get_transfer_learning_models(project_id: StrictInt, **kwargs)

Retrieves available transfer learning models

Retrieves available transfer learning models

• 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

  OptimizeTransferLearningModelsResponse

get_trial_logs(project_id: StrictInt, trial_id: StrictStr, limit: Optional[StrictInt] = None, log_level: Optional[StrictStr] = None, **kwargs)

Get trial logs

Get the logs for a trial.

• Parameters

  • project_id (int) – Project ID (required)

  • trial_id (str) – trial 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_window_settings(project_id: StrictInt, **kwargs)

Get window settings

Get window settings

• 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

  WindowSettingsResponse

score_trial(project_id: StrictInt, tuner_create_trial_impulse: TunerCreateTrialImpulse, **kwargs)

Score trial

Score trial

• Parameters

  • project_id (int) – Project ID (required)

  • tuner_create_trial_impulse (TunerCreateTrialImpulse) – (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

  ScoreTrialResponse

update_config(project_id: StrictInt, optimize_config: OptimizeConfig, **kwargs)

Update config

Update config

• Parameters

  • project_id (int) – Project ID (required)

  • optimize_config (OptimizeConfig) – (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