Skip to content

Commit 548c487

Browse files
committed
Merge branch 'priming_sdk' of github.com:groundlight/python-sdk into priming_sdk
2 parents 92db96d + 9fbd829 commit 548c487

File tree

12 files changed

+87
-219
lines changed

12 files changed

+87
-219
lines changed

generated/.openapi-generator/FILES

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -168,10 +168,4 @@ setup.cfg
168168
setup.py
169169
test-requirements.txt
170170
test/__init__.py
171-
test/test_ml_pipeline.py
172-
test/test_paginated_ml_pipeline_list.py
173-
test/test_paginated_priming_group_list.py
174-
test/test_priming_group.py
175-
test/test_priming_group_creation_input_request.py
176-
test/test_priming_groups_api.py
177171
tox.ini

generated/docs/PrimingGroup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**id** | **str** | | [readonly]
99
**name** | **str** | |
10-
**is_global** | **bool** | If True, this priming group is shared to all Groundlight users by Groundlight admins. | [readonly]
10+
**is_global** | **bool** | If True, this priming group is shared to all Groundlight users. Can only be set by Groundlight admins. | [readonly]
1111
**created_at** | **datetime** | | [readonly]
1212
**canonical_query** | **str, none_type** | Canonical semantic query for this priming group | [optional]
13-
**active_pipeline_config** | **str, none_type** | Active pipeline config override for detectors in this priming group. If set, this overrides the default active pipeline config. Can be either a pipeline name or full config string. | [optional]
14-
**priming_group_specific_shadow_pipeline_configs** | **bool, date, datetime, dict, float, int, list, str, none_type** | Priming group-specific shadow pipeline configs to create for detectors in this priming group. These are added to the default shadow pipeline configs for a detector of the given modeEach entry is either a pipeline name or full config string. | [optional]
13+
**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]
14+
**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]
1515
**disable_shadow_pipelines** | **bool** | If True, new detectors added to this priming group will not receive the mode-specific default shadow pipelines from INITIAL_SHADOW_PIPELINE_CONFIG_SET. Priming-group-specific shadow configs still apply. Use this to guarantee the primed active MLBinary is never switched off by a shadow pipeline being promoted. | [optional]
1616
**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]
1717

generated/docs/PrimingGroupCreationInputRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Input for creating a new user-owned PrimingGroup seeded from an existing MLPipel
55
## Properties
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**name** | **str** | Unique name for the new priming group. |
8+
**name** | **str** | Name for the new priming group. |
99
**source_ml_pipeline_id** | **str** | ID of an MLPipeline owned by this account whose trained model will seed the priming group. |
1010
**canonical_query** | **str, none_type** | Optional canonical semantic query describing this priming group. | [optional]
1111
**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

generated/docs/PrimingGroupsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ Name | Type | Description | Notes
250250
251251

252252

253-
List all priming groups owned by the authenticated user.
253+
List all priming groups either owned by the authenticated user, or with is_global=True.
254254

255255
### Example
256256

generated/groundlight_openapi_client/api/priming_groups_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ def get_priming_group(self, id, **kwargs):
383383
def list_priming_groups(self, **kwargs):
384384
"""list_priming_groups # noqa: E501
385385
386-
List all priming groups owned by the authenticated user. # noqa: E501
386+
List all priming groups either owned by the authenticated user, or with is_global=True. # noqa: E501
387387
This method makes a synchronous HTTP request by default. To make an
388388
asynchronous HTTP request, please pass async_req=True
389389

generated/groundlight_openapi_client/model/priming_group.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ def _from_openapi_data(cls, id, name, is_global, created_at, *args, **kwargs):
157157
Args:
158158
id (str):
159159
name (str):
160-
is_global (bool): If True, this priming group is shared to all Groundlight users by Groundlight admins.
160+
is_global (bool): If True, this priming group is shared to all Groundlight users. Can only be set by Groundlight admins.
161161
created_at (datetime):
162162
163163
Keyword Args:
@@ -192,8 +192,8 @@ def _from_openapi_data(cls, id, name, is_global, created_at, *args, **kwargs):
192192
through its discriminator because we passed in
193193
_visited_composed_classes = (Animal,)
194194
canonical_query (str, none_type): Canonical semantic query for this priming group. [optional] # noqa: E501
195-
active_pipeline_config (str, none_type): Active pipeline config override for detectors in this priming group. If set, this overrides the default active pipeline config. Can be either a pipeline name or full config string.. [optional] # noqa: E501
196-
priming_group_specific_shadow_pipeline_configs (bool, date, datetime, dict, float, int, list, str, none_type): Priming group-specific shadow pipeline configs to create for detectors in this priming group. These are added to the default shadow pipeline configs for a detector of the given modeEach entry is either a pipeline name or full config string. . [optional] # noqa: E501
195+
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] # noqa: E501
196+
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] # noqa: E501
197197
disable_shadow_pipelines (bool): If True, new detectors added to this priming group will not receive the mode-specific default shadow pipelines from INITIAL_SHADOW_PIPELINE_CONFIG_SET. Priming-group-specific shadow configs still apply. Use this to guarantee the primed active MLBinary is never switched off by a shadow pipeline being promoted.. [optional] # noqa: E501
198198
"""
199199

@@ -285,8 +285,8 @@ def __init__(self, name, *args, **kwargs): # noqa: E501
285285
through its discriminator because we passed in
286286
_visited_composed_classes = (Animal,)
287287
canonical_query (str, none_type): Canonical semantic query for this priming group. [optional] # noqa: E501
288-
active_pipeline_config (str, none_type): Active pipeline config override for detectors in this priming group. If set, this overrides the default active pipeline config. Can be either a pipeline name or full config string.. [optional] # noqa: E501
289-
priming_group_specific_shadow_pipeline_configs (bool, date, datetime, dict, float, int, list, str, none_type): Priming group-specific shadow pipeline configs to create for detectors in this priming group. These are added to the default shadow pipeline configs for a detector of the given modeEach entry is either a pipeline name or full config string. . [optional] # noqa: E501
288+
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] # noqa: E501
289+
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] # noqa: E501
290290
disable_shadow_pipelines (bool): If True, new detectors added to this priming group will not receive the mode-specific default shadow pipelines from INITIAL_SHADOW_PIPELINE_CONFIG_SET. Priming-group-specific shadow configs still apply. Use this to guarantee the primed active MLBinary is never switched off by a shadow pipeline being promoted.. [optional] # noqa: E501
291291
"""
292292

generated/groundlight_openapi_client/model/priming_group_creation_input_request.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ def _from_openapi_data(cls, name, source_ml_pipeline_id, *args, **kwargs): # no
130130
"""PrimingGroupCreationInputRequest - a model defined in OpenAPI
131131
132132
Args:
133-
name (str): Unique name for the new priming group.
133+
name (str): Name for the new priming group.
134134
source_ml_pipeline_id (str): ID of an MLPipeline owned by this account whose trained model will seed the priming group.
135135
136136
Keyword Args:
@@ -222,7 +222,7 @@ def __init__(self, name, source_ml_pipeline_id, *args, **kwargs): # noqa: E501
222222
"""PrimingGroupCreationInputRequest - a model defined in OpenAPI
223223
224224
Args:
225-
name (str): Unique name for the new priming group.
225+
name (str): Name for the new priming group.
226226
source_ml_pipeline_id (str): ID of an MLPipeline owned by this account whose trained model will seed the priming group.
227227
228228
Keyword Args:

generated/model.py

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# generated by datamodel-codegen:
22
# filename: public-api.yaml
3-
# timestamp: 2026-04-01T21:37:01+00:00
3+
# timestamp: 2026-04-07T00:20:58+00:00
44

55
from __future__ import annotations
66

@@ -167,24 +167,27 @@ class PrimingGroup(BaseModel):
167167
id: str
168168
name: constr(max_length=100)
169169
is_global: bool = Field(
170-
..., description="If True, this priming group is shared to all Groundlight users by Groundlight admins."
170+
...,
171+
description=(
172+
"If True, this priming group is shared to all Groundlight users. Can only be set by Groundlight admins."
173+
),
171174
)
172175
canonical_query: Optional[constr(max_length=300)] = Field(
173176
None, description="Canonical semantic query for this priming group"
174177
)
175178
active_pipeline_config: Optional[constr(max_length=8192)] = Field(
176179
None,
177180
description=(
178-
"Active pipeline config override for detectors in this priming group. If set, this overrides the default"
179-
" active pipeline config. Can be either a pipeline name or full config string."
181+
"Active pipeline config override for new detectors created in this priming group. If set, this overrides"
182+
" the default active pipeline config at creation time.Can be either a pipeline name or full config string."
180183
),
181184
)
182185
priming_group_specific_shadow_pipeline_configs: Optional[Any] = Field(
183186
None,
184187
description=(
185-
"Priming group-specific shadow pipeline configs to create for detectors in this priming group. These are"
186-
" added to the default shadow pipeline configs for a detector of the given modeEach entry is either a"
187-
" pipeline name or full config string. "
188+
"Configs for shadow pipelines to create for detectors in this priming group. These are added to the default"
189+
" shadow pipeline configs for a detector of the given mode. Each entry is either a pipeline name or full"
190+
" config string. "
188191
),
189192
)
190193
disable_shadow_pipelines: Optional[bool] = Field(
@@ -203,7 +206,7 @@ class PrimingGroupCreationInputRequest(BaseModel):
203206
Input for creating a new user-owned PrimingGroup seeded from an existing MLPipeline.
204207
"""
205208

206-
name: constr(min_length=1, max_length=100) = Field(..., description="Unique name for the new priming group.")
209+
name: constr(min_length=1, max_length=100) = Field(..., description="Name for the new priming group.")
207210
source_ml_pipeline_id: constr(min_length=1, max_length=44) = Field(
208211
..., description="ID of an MLPipeline owned by this account whose trained model will seed the priming group."
209212
)

package-lock.json

Lines changed: 1 addition & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

spec/public-api.yaml

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -855,7 +855,8 @@ paths:
855855
/v1/priming-groups:
856856
get:
857857
operationId: List priming groups
858-
description: List all priming groups owned by the authenticated user.
858+
description: List all priming groups either owned by the authenticated user,
859+
or with is_global=True.
859860
parameters:
860861
- name: ordering
861862
required: false
@@ -1737,8 +1738,8 @@ components:
17371738
is_global:
17381739
type: boolean
17391740
readOnly: true
1740-
description: If True, this priming group is shared to all Groundlight users
1741-
by Groundlight admins.
1741+
description: If True, this priming group is shared to all Groundlight users.
1742+
Can only be set by Groundlight admins.
17421743
canonical_query:
17431744
type: string
17441745
nullable: true
@@ -1747,16 +1748,16 @@ components:
17471748
active_pipeline_config:
17481749
type: string
17491750
nullable: true
1750-
description: Active pipeline config override for detectors in this priming
1751-
group. If set, this overrides the default active pipeline config. Can
1752-
be either a pipeline name or full config string.
1751+
description: Active pipeline config override for new detectors created in
1752+
this priming group. If set, this overrides the default active pipeline
1753+
config at creation time.Can be either a pipeline name or full config string.
17531754
maxLength: 8192
17541755
priming_group_specific_shadow_pipeline_configs:
17551756
nullable: true
1756-
description: 'Priming group-specific shadow pipeline configs to create for
1757-
detectors in this priming group. These are added to the default shadow
1758-
pipeline configs for a detector of the given modeEach entry is either
1759-
a pipeline name or full config string. '
1757+
description: 'Configs for shadow pipelines to create for detectors in this
1758+
priming group. These are added to the default shadow pipeline configs
1759+
for a detector of the given mode. Each entry is either a pipeline name
1760+
or full config string. '
17601761
disable_shadow_pipelines:
17611762
type: boolean
17621763
description: If True, new detectors added to this priming group will not
@@ -1782,7 +1783,7 @@ components:
17821783
name:
17831784
type: string
17841785
minLength: 1
1785-
description: Unique name for the new priming group.
1786+
description: Name for the new priming group.
17861787
maxLength: 100
17871788
source_ml_pipeline_id:
17881789
type: string

0 commit comments

Comments
 (0)