Merge branch 'main' into dependabot/npm_and_yarn/docs/node-forge-1.3.3

Author: f-wright

Makefile

@@ -38,8 +38,8 @@ PYTEST=poetry run pytest -v
 # 	`make test TEST_ARGS="-k some_filter"`
 TEST_ARGS=
 
-CLOUD_FILTERS = -m "not run_only_for_edge_endpoint"
-EDGE_FILTERS = -m "not skip_for_edge_endpoint"
+CLOUD_FILTERS = -m "not run_only_for_edge_endpoint and not expensive"
+EDGE_FILTERS = -m "not skip_for_edge_endpoint and not expensive"
 
 # Record information about the slowest 25 tests (but don't show anything slower than 0.1 seconds)
 PROFILING_ARGS = \

docs/docs/guide/8-edge.md

@@ -38,6 +38,46 @@ python your_app.py
 In the above example, the `edge-endpoint` is running on the same machine as the application, so the endpoint URL is `http://localhost:30101`. If the `edge-endpoint` is running on a different machine, you should replace `localhost` with the IP address or hostname of the machine running the `edge-endpoint`.
 :::
 
+## Configuring the Edge Endpoint at Runtime
+
+:::note
+Runtime edge configuration is currently in beta and available through the `ExperimentalApi`.
+:::
+
+You can programmatically configure which detectors run on the edge and how they behave, without redeploying. 
+
+This allows applications to define the desired state of the Edge Endpoint, thereby eliminating the need to manually configure the Edge Endpoint separately.
+
+```python notest
+from groundlight import ExperimentalApi
+from groundlight.edge import EdgeEndpointConfig
+from groundlight.edge.config import NO_CLOUD, EDGE_ANSWERS_WITH_ESCALATION
+
+# Connect to an Edge Endpoint
+gl = ExperimentalApi(endpoint="http://localhost:30101")
+
+# Build a configuration with detectors and inference presets
+config = EdgeEndpointConfig()
+config.add_detector("det_YOUR_DETECTOR_ID_HERE_01", NO_CLOUD)
+config.add_detector("det_YOUR_DETECTOR_ID_HERE_02", EDGE_ANSWERS_WITH_ESCALATION)
+
+# Apply the configuration and wait for detectors to be ready
+print("Applying configuration...")
+config = gl.edge.set_config(config)
+print(f"Applied config with {len(config.detectors)} detector(s)")
+```
+
+`set_config` replaces the current configuration and blocks until all detectors have inference pods ready to serve requests (or until the timeout expires).
+
+You can also inspect the current configuration:
+
+```python notest
+# Retrieve the active configuration
+config = gl.edge.get_config()
+for det in config.detectors:
+    print(f"  {det.detector_id} -> {det.edge_inference_config}")
+```
+
 ## Edge Endpoint performance
 
 We have benchmarked the `edge-endpoint` handling 500 requests/sec at a latency of less than 50ms on an off-the-shelf [Katana 15 B13VGK-1007US](https://us.msi.com/Laptop/Katana-15-B13VX/Specification) laptop (Intel® Core™ i9-13900H CPU, NVIDIA® GeForce RTX™ 4070 Laptop GPU, 32GB DDR5 5200MHz RAM) running Ubuntu 20.04.

docs/package-lock.json

@@ -42,6 +42,7 @@ docs/Label.md
 docs/LabelValue.md
 docs/LabelValueRequest.md
 docs/LabelsApi.md
+docs/MLPipeline.md
 docs/ModeEnum.md
 docs/MonthToDateAccountInfoApi.md
 docs/MultiClassModeConfiguration.md
@@ -51,10 +52,15 @@ docs/NoteRequest.md
 docs/NotesApi.md
 docs/PaginatedDetectorList.md
 docs/PaginatedImageQueryList.md
+docs/PaginatedMLPipelineList.md
+docs/PaginatedPrimingGroupList.md
 docs/PaginatedRuleList.md
 docs/PatchedDetectorRequest.md
 docs/PayloadTemplate.md
 docs/PayloadTemplateRequest.md
+docs/PrimingGroup.md
+docs/PrimingGroupCreationInputRequest.md
+docs/PrimingGroupsApi.md
 docs/ROI.md
 docs/ROIRequest.md
 docs/ResultTypeEnum.md
@@ -82,6 +88,7 @@ groundlight_openapi_client/api/image_queries_api.py
 groundlight_openapi_client/api/labels_api.py
 groundlight_openapi_client/api/month_to_date_account_info_api.py
 groundlight_openapi_client/api/notes_api.py
+groundlight_openapi_client/api/priming_groups_api.py
 groundlight_openapi_client/api/user_api.py
 groundlight_openapi_client/api_client.py
 groundlight_openapi_client/apis/__init__.py
@@ -123,17 +130,22 @@ groundlight_openapi_client/model/inline_response200_summary_class_counts.py
 groundlight_openapi_client/model/label.py
 groundlight_openapi_client/model/label_value.py
 groundlight_openapi_client/model/label_value_request.py
+groundlight_openapi_client/model/ml_pipeline.py
 groundlight_openapi_client/model/mode_enum.py
 groundlight_openapi_client/model/multi_class_mode_configuration.py
 groundlight_openapi_client/model/multi_classification_result.py
 groundlight_openapi_client/model/note.py
 groundlight_openapi_client/model/note_request.py
 groundlight_openapi_client/model/paginated_detector_list.py
 groundlight_openapi_client/model/paginated_image_query_list.py
+groundlight_openapi_client/model/paginated_ml_pipeline_list.py
+groundlight_openapi_client/model/paginated_priming_group_list.py
 groundlight_openapi_client/model/paginated_rule_list.py
 groundlight_openapi_client/model/patched_detector_request.py
 groundlight_openapi_client/model/payload_template.py
 groundlight_openapi_client/model/payload_template_request.py
+groundlight_openapi_client/model/priming_group.py
+groundlight_openapi_client/model/priming_group_creation_input_request.py
 groundlight_openapi_client/model/result_type_enum.py
 groundlight_openapi_client/model/roi.py
 groundlight_openapi_client/model/roi_request.py

generated/.openapi-generator/FILES

@@ -128,6 +128,7 @@ Class | Method | HTTP request | Description
 *DetectorsApi* | [**get_detector**](docs/DetectorsApi.md#get_detector) | **GET** /v1/detectors/{id} | 
 *DetectorsApi* | [**get_detector_evaluation**](docs/DetectorsApi.md#get_detector_evaluation) | **GET** /v1/detectors/{id}/evaluation | 
 *DetectorsApi* | [**get_detector_metrics**](docs/DetectorsApi.md#get_detector_metrics) | **GET** /v1/detectors/{detector_id}/metrics | 
+*DetectorsApi* | [**list_detector_pipelines**](docs/DetectorsApi.md#list_detector_pipelines) | **GET** /v1/detectors/{detector_id}/pipelines | 
 *DetectorsApi* | [**list_detectors**](docs/DetectorsApi.md#list_detectors) | **GET** /v1/detectors | 
 *DetectorsApi* | [**update_detector**](docs/DetectorsApi.md#update_detector) | **PATCH** /v1/detectors/{id} | 
 *EdgeApi* | [**edge_report_metrics_create**](docs/EdgeApi.md#edge_report_metrics_create) | **POST** /v1/edge/report-metrics | 
@@ -140,6 +141,10 @@ Class | Method | HTTP request | Description
 *MonthToDateAccountInfoApi* | [**month_to_date_account_info**](docs/MonthToDateAccountInfoApi.md#month_to_date_account_info) | **GET** /v1/month-to-date-account-info | 
 *NotesApi* | [**create_note**](docs/NotesApi.md#create_note) | **POST** /v1/notes | 
 *NotesApi* | [**get_notes**](docs/NotesApi.md#get_notes) | **GET** /v1/notes | 
+*PrimingGroupsApi* | [**create_priming_group**](docs/PrimingGroupsApi.md#create_priming_group) | **POST** /v1/priming-groups | 
+*PrimingGroupsApi* | [**delete_priming_group**](docs/PrimingGroupsApi.md#delete_priming_group) | **DELETE** /v1/priming-groups/{id} | 
+*PrimingGroupsApi* | [**get_priming_group**](docs/PrimingGroupsApi.md#get_priming_group) | **GET** /v1/priming-groups/{id} | 
+*PrimingGroupsApi* | [**list_priming_groups**](docs/PrimingGroupsApi.md#list_priming_groups) | **GET** /v1/priming-groups | 
 *UserApi* | [**who_am_i**](docs/UserApi.md#who_am_i) | **GET** /v1/me | 
 
 
@@ -180,17 +185,22 @@ Class | Method | HTTP request | Description
  - [Label](docs/Label.md)
  - [LabelValue](docs/LabelValue.md)
  - [LabelValueRequest](docs/LabelValueRequest.md)
+ - [MLPipeline](docs/MLPipeline.md)
  - [ModeEnum](docs/ModeEnum.md)
  - [MultiClassModeConfiguration](docs/MultiClassModeConfiguration.md)
  - [MultiClassificationResult](docs/MultiClassificationResult.md)
  - [Note](docs/Note.md)
  - [NoteRequest](docs/NoteRequest.md)
  - [PaginatedDetectorList](docs/PaginatedDetectorList.md)
  - [PaginatedImageQueryList](docs/PaginatedImageQueryList.md)
+ - [PaginatedMLPipelineList](docs/PaginatedMLPipelineList.md)
+ - [PaginatedPrimingGroupList](docs/PaginatedPrimingGroupList.md)
  - [PaginatedRuleList](docs/PaginatedRuleList.md)
  - [PatchedDetectorRequest](docs/PatchedDetectorRequest.md)
  - [PayloadTemplate](docs/PayloadTemplate.md)
  - [PayloadTemplateRequest](docs/PayloadTemplateRequest.md)
+ - [PrimingGroup](docs/PrimingGroup.md)
+ - [PrimingGroupCreationInputRequest](docs/PrimingGroupCreationInputRequest.md)
  - [ROI](docs/ROI.md)
  - [ROIRequest](docs/ROIRequest.md)
  - [ResultTypeEnum](docs/ResultTypeEnum.md)

generated/README.md

@@ -11,9 +11,11 @@ Name | Type | Description | Notes
 **confidence_threshold** | **float** | If the detector's prediction is below this confidence threshold, send the image query for human review. | [optional]  if omitted the server will use the default value of 0.9
 **patience_time** | **float** | How long Groundlight will attempt to generate a confident prediction | [optional]  if omitted the server will use the default value of 30.0
 **pipeline_config** | **str, none_type** | (Advanced usage) Configuration needed to instantiate a prediction pipeline. | [optional] 
+**edge_pipeline_config** | **str, none_type** | (Advanced usage) Configuration for the edge inference pipeline. If not specified, the mode's default edge pipeline is used. | [optional] 
 **metadata** | **str** | Base64-encoded metadata for the detector. This should be a JSON object with string keys. The size after encoding should not exceed 1362 bytes, corresponding to 1KiB before encoding. | [optional] 
 **mode** | **bool, date, datetime, dict, float, int, list, str, none_type** | Mode in which this detector will work.  * `BINARY` - BINARY * `COUNT` - COUNT * `MULTI_CLASS` - MULTI_CLASS * `TEXT` - TEXT * `BOUNDING_BOX` - BOUNDING_BOX | [optional] 
 **mode_configuration** | **bool, date, datetime, dict, float, int, list, str, none_type** |  | [optional] 
+**priming_group_id** | **str, none_type** | ID of an existing PrimingGroup to associate with this detector (optional). | [optional] 
 **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

generated/docs/DetectorCreationInputRequest.md

@@ -9,6 +9,7 @@ Method | HTTP request | Description
 [**get_detector**](DetectorsApi.md#get_detector) | **GET** /v1/detectors/{id} | 
 [**get_detector_evaluation**](DetectorsApi.md#get_detector_evaluation) | **GET** /v1/detectors/{id}/evaluation | 
 [**get_detector_metrics**](DetectorsApi.md#get_detector_metrics) | **GET** /v1/detectors/{detector_id}/metrics | 
+[**list_detector_pipelines**](DetectorsApi.md#list_detector_pipelines) | **GET** /v1/detectors/{detector_id}/pipelines | 
 [**list_detectors**](DetectorsApi.md#list_detectors) | **GET** /v1/detectors | 
 [**update_detector**](DetectorsApi.md#update_detector) | **PATCH** /v1/detectors/{id} | 
 
@@ -59,9 +60,11 @@ with groundlight_openapi_client.ApiClient(configuration) as api_client:
         confidence_threshold=0.9,
         patience_time=30.0,
         pipeline_config="pipeline_config_example",
+        edge_pipeline_config="edge_pipeline_config_example",
         metadata="metadata_example",
         mode=None,
         mode_configuration=None,
+        priming_group_id="priming_group_id_example",
     ) # DetectorCreationInputRequest | 
 
     # example passing only required values which don't have defaults set
@@ -399,6 +402,99 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **list_detector_pipelines**
+> PaginatedMLPipelineList list_detector_pipelines(detector_id)
+
+
+
+List all MLPipelines for a detector.
+
+### Example
+
+* Api Key Authentication (ApiToken):
+
+```python
+import time
+import groundlight_openapi_client
+from groundlight_openapi_client.api import detectors_api
+from groundlight_openapi_client.model.paginated_ml_pipeline_list import PaginatedMLPipelineList
+from pprint import pprint
+# Defining the host is optional and defaults to https://api.groundlight.ai/device-api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = groundlight_openapi_client.Configuration(
+    host = "https://api.groundlight.ai/device-api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: ApiToken
+configuration.api_key['ApiToken'] = 'YOUR_API_KEY'
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['ApiToken'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with groundlight_openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = detectors_api.DetectorsApi(api_client)
+    detector_id = "detector_id_example" # str | 
+    ordering = "ordering_example" # str | Which field to use when ordering the results. (optional)
+    page = 1 # int | A page number within the paginated result set. (optional)
+    page_size = 1 # int | Number of results to return per page. (optional)
+    search = "search_example" # str | A search term. (optional)
+
+    # example passing only required values which don't have defaults set
+    try:
+        api_response = api_instance.list_detector_pipelines(detector_id)
+        pprint(api_response)
+    except groundlight_openapi_client.ApiException as e:
+        print("Exception when calling DetectorsApi->list_detector_pipelines: %s\n" % e)
+
+    # example passing only required values which don't have defaults set
+    # and optional values
+    try:
+        api_response = api_instance.list_detector_pipelines(detector_id, ordering=ordering, page=page, page_size=page_size, search=search)
+        pprint(api_response)
+    except groundlight_openapi_client.ApiException as e:
+        print("Exception when calling DetectorsApi->list_detector_pipelines: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **detector_id** | **str**|  |
+ **ordering** | **str**| Which field to use when ordering the results. | [optional]
+ **page** | **int**| A page number within the paginated result set. | [optional]
+ **page_size** | **int**| Number of results to return per page. | [optional]
+ **search** | **str**| A search term. | [optional]
+
+### Return type
+
+[**PaginatedMLPipelineList**](PaginatedMLPipelineList.md)
+
+### Authorization
+
+[ApiToken](../README.md#ApiToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 
 | Status code | Description | Response headers |

generated/docs/DetectorsApi.md

@@ -0,0 +1,21 @@
+# MLPipeline
+
+A single ML pipeline attached to a detector.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** |  | [readonly] 
+**pipeline_config** | **str, none_type** | configuration needed to instantiate a prediction pipeline. | [readonly] 
+**is_active_pipeline** | **bool** | If True, this is the pipeline is used for inference, active learning, etc. for its parent Predictor. | [readonly] 
+**is_edge_pipeline** | **bool** | If True, this pipeline is enabled for edge inference. | [readonly] 
+**is_unclear_pipeline** | **bool** | If True, this pipeline is used to train classifier for human unclear label prediction. | [readonly] 
+**is_oodd_pipeline** | **bool** | If True, this pipeline is used for OODD. | [readonly] 
+**is_enabled** | **bool** | If False, this pipeline will not be run for any use case. | [readonly] 
+**created_at** | **datetime** |  | [readonly] 
+**trained_at** | **datetime, none_type** |  | [readonly] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

generated/docs/MLPipeline.md

@@ -0,0 +1,15 @@
+# PaginatedMLPipelineList
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **int** |  | 
+**results** | [**[MLPipeline]**](MLPipeline.md) |  | 
+**next** | **str, none_type** |  | [optional] 
+**previous** | **str, none_type** |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

generated/docs/PaginatedMLPipelineList.md

@@ -0,0 +1,15 @@
+# PaginatedPrimingGroupList
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **int** |  | 
+**results** | [**[PrimingGroup]**](PrimingGroup.md) |  | 
+**next** | **str, none_type** |  | [optional] 
+**previous** | **str, none_type** |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+