Skip to content

feat: plumb detector_mode through create_priming_group #430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brandon-wada merged 6 commits into from
May 5, 2026
Merged

feat: plumb detector_mode through create_priming_group #430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
282a324
feat: plumb detector_mode through create_priming_group
brandon-wada May 5, 2026
89a5ed0
fix(lint): silence too-many-arguments on create_priming_group
brandon-wada May 5, 2026
7c8400c
test: add multiclass num_classes auto-population coverage
brandon-wada May 5, 2026
832292d
fix(test): include TextRecognitionResult in is_valid_display_result
brandon-wada May 5, 2026
4a16697
Automatically reformatting code
May 5, 2026
f8cd750
ci: retrigger CI on auto-format bot commit
brandon-wada May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions generated/.openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ docs/DetectorCreationInputRequest.md
docs/DetectorGroup.md
docs/DetectorGroupRequest.md
docs/DetectorGroupsApi.md
docs/DetectorModeEnum.md
docs/DetectorResetApi.md
docs/DetectorTypeEnum.md
docs/DetectorsApi.md
Expand Down Expand Up @@ -50,6 +51,7 @@ docs/MultiClassificationResult.md
docs/Note.md
docs/NoteRequest.md
docs/NotesApi.md
docs/NullEnum.md
docs/PaginatedDetectorList.md
docs/PaginatedImageQueryList.md
docs/PaginatedMLPipelineList.md
Expand Down Expand Up @@ -116,6 +118,7 @@ groundlight_openapi_client/model/detector.py
groundlight_openapi_client/model/detector_creation_input_request.py
groundlight_openapi_client/model/detector_group.py
groundlight_openapi_client/model/detector_group_request.py
groundlight_openapi_client/model/detector_mode_enum.py
groundlight_openapi_client/model/detector_type_enum.py
groundlight_openapi_client/model/edge_model_info.py
groundlight_openapi_client/model/escalation_type_enum.py
Expand All @@ -136,6 +139,7 @@ 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/null_enum.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
Expand Down Expand Up @@ -168,4 +172,6 @@ setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_detector_mode_enum.py
test/test_null_enum.py
tox.ini
2 changes: 2 additions & 0 deletions generated/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ Class | Method | HTTP request | Description
- [DetectorCreationInputRequest](docs/DetectorCreationInputRequest.md)
- [DetectorGroup](docs/DetectorGroup.md)
- [DetectorGroupRequest](docs/DetectorGroupRequest.md)
- [DetectorModeEnum](docs/DetectorModeEnum.md)
- [DetectorTypeEnum](docs/DetectorTypeEnum.md)
- [EdgeModelInfo](docs/EdgeModelInfo.md)
- [EscalationTypeEnum](docs/EscalationTypeEnum.md)
Expand All @@ -191,6 +192,7 @@ Class | Method | HTTP request | Description
- [MultiClassificationResult](docs/MultiClassificationResult.md)
- [Note](docs/Note.md)
- [NoteRequest](docs/NoteRequest.md)
- [NullEnum](docs/NullEnum.md)
- [PaginatedDetectorList](docs/PaginatedDetectorList.md)
- [PaginatedImageQueryList](docs/PaginatedImageQueryList.md)
- [PaginatedMLPipelineList](docs/PaginatedMLPipelineList.md)
Expand Down
12 changes: 12 additions & 0 deletions generated/docs/DetectorModeEnum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# DetectorModeEnum

* `BINARY` - BINARY * `COUNT` - COUNT * `MULTI_CLASS` - MULTI_CLASS * `TEXT` - TEXT * `BOUNDING_BOX` - BOUNDING_BOX
Copy link
Copy Markdown
Contributor

@f-wright f-wright May 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this doesn't go in this PR, but it seems like it'd make more sense for these to be in alphabetical order. Right now they seem to be in order of when they were added, but that's kind of odd since we don't really use count and text mode all that much anymore


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **str** | * `BINARY` - BINARY * `COUNT` - COUNT * `MULTI_CLASS` - MULTI_CLASS * `TEXT` - TEXT * `BOUNDING_BOX` - BOUNDING_BOX | must be one of ["BINARY", "COUNT", "MULTI_CLASS", "TEXT", "BOUNDING_BOX", ]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 10 additions & 2 deletions generated/docs/MLPipeline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,27 @@
# MLPipeline

A single ML pipeline attached to a detector.
A single ML pipeline attached to a detector. Includes training status and metrics for the Pipeline Details UI.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [readonly]
**pipeline_config** | **str, none_type** | configuration needed to instantiate a prediction pipeline. | [readonly]
**pipeline_config** | **str** | Get the resolved pipeline config, including defaults. | [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]
**type** | **str** | Determine the pipeline type (active, shadow, unclear, oodd). | [readonly]
**friendly_name** | **str, none_type** | Get the friendly name from the MLBinary. | [readonly]
**model_binary_id** | **str, none_type** | |
**training_in_progress** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Check if training is currently in progress for this pipeline. | [readonly]
**metrics** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Get the metrics for this pipeline from MLBinary metadata and evaluation results. | [readonly]
**eval_mlbinary_key** | **str, none_type** | Get the MLBinary key that was evaluated. | [readonly]
**eval_mlbinary_revision_number** | **int, none_type** | Get the revision number of the MLBinary that was evaluated. | [readonly]
**eval_mlbinary_friendly_name** | **str, none_type** | Get the friendly name of the MLBinary that was evaluated. | [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)
Expand Down
2 changes: 2 additions & 0 deletions generated/docs/PrimingGroup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [readonly]
**name** | **str** | |
**num_classes** | **int, none_type** | Number of output classes this priming group is trained for. Set automatically from the source predictor when created via create_user_priming_group (MULTI_CLASS only). Nullable for legacy rows and for modes where class count isn't meaningful; a follow-up PR will tighten this after manual backfill. | [readonly]
**is_global** | **bool** | If True, this priming group is shared to all Groundlight users. Can only be set by Groundlight admins. | [readonly]
**created_at** | **datetime** | | [readonly]
**detector_mode** | **bool, date, datetime, dict, float, int, list, str, none_type** | Detector mode this priming group is intended for (BINARY, MULTI_CLASS, etc.). Validated against the pipeline_config of every active and shadow base MLBinary in clean(). Nullable only for legacy rows pre-dating this field; new PrimingGroups must set it. * `BINARY` - BINARY * `COUNT` - COUNT * `MULTI_CLASS` - MULTI_CLASS * `TEXT` - TEXT * `BOUNDING_BOX` - BOUNDING_BOX | [optional]
**canonical_query** | **str, none_type** | Canonical semantic query for this priming group | [optional]
**active_pipeline_config** | **str, none_type** | Active pipeline config override for new detectors created in this priming group. If set, this overrides the default active pipeline config at creation time.Can be either a pipeline name or full config string. | [optional]
**priming_group_specific_shadow_pipeline_configs** | **bool, date, datetime, dict, float, int, list, str, none_type** | Configs for shadow pipelines to create for detectors in this priming group. These are added to the default shadow pipeline configs for a detector of the given mode. Each entry is either a pipeline name or full config string. | [optional]
Expand Down
1 change: 1 addition & 0 deletions generated/docs/PrimingGroupCreationInputRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name for the new priming group. |
**source_ml_pipeline_id** | **str** | ID of an MLPipeline owned by this account whose trained model will seed the priming group. |
**detector_mode** | **bool, date, datetime, dict, float, int, list, str, none_type** | Detector mode this priming group is intended for (BINARY, MULTI_CLASS, etc.). Must match the mode supported by the source MLPipeline's pipeline_config. * `BINARY` - BINARY * `COUNT` - COUNT * `MULTI_CLASS` - MULTI_CLASS * `TEXT` - TEXT * `BOUNDING_BOX` - BOUNDING_BOX |
Copy link
Copy Markdown
Contributor

@f-wright f-wright May 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does this have so many type options? Do we need to tighten this on the back end?

**canonical_query** | **str, none_type** | Optional canonical semantic query describing this priming group. | [optional]
**disable_shadow_pipelines** | **bool** | If true, new detectors added to this priming group will not receive the default shadow pipelines. This guarantees the primed active model is never switched off. | [optional] if omitted the server will use the default value of False
**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]
Expand Down
1 change: 1 addition & 0 deletions generated/docs/PrimingGroupsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ with groundlight_openapi_client.ApiClient(configuration) as api_client:
priming_group_creation_input_request = PrimingGroupCreationInputRequest(
name="name_example",
source_ml_pipeline_id="source_ml_pipeline_id_example",
detector_mode=None,
canonical_query="canonical_query_example",
disable_shadow_pipelines=False,
) # PrimingGroupCreationInputRequest |
Expand Down
Loading
Loading