fix(BA-1380): Update `Service.create()` to comply with validation schema #4449

rapsealk · 2025-05-21T06:02:31Z

This pull request updates the client SDK to align method signatures with the NewServiceRequestModel schema and introduces non-optional parameters for resource and configuration details in service-related methods. These changes ensure stricter compliance with expected input requirements and improve the clarity and reliability of the SDK.

SDK Method Signature Updates:

changes/.fix.md: Updated documentation to reflect that the Service.create() method signature now complies with the NewServiceRequestModel schema.

Parameter Adjustments in Service Methods:

src/ai/backend/client/func/service.py:
- create: Made resources, resource_opts, domain_name, group_name, and scaling_group required positional parameters. Changed expose_to_public from an implicit boolean to an explicitly typed bool. [1] [2]
- try_start: Applied the same parameter changes as in create, ensuring consistency across service-related methods.

Checklist: (if applicable)

Milestone metadata specifying the target backport version
Mention to the original issue
Update of end-to-end CLI integration tests in ai.backend.test
API server-client counterparts (e.g., manager API -> client SDK)

…h `NewServiceRequestModel` schema

.fix.md -> 4449.fix.md Co-authored-by: octodog <mu001@lablup.com>

Copilot

Pull Request Overview

This PR aligns the Service.create() and Service.try_start() client SDK methods with the NewServiceRequestModel schema by making key resource and configuration parameters required and enforcing explicit typing.

Adjusted method signatures for create and try_start to require resources, resource_opts, domain_name, group_name, scaling_group as positional-only, and changed expose_to_public to be explicitly bool.
Added a changelog entry for the Service.create() signature change.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
src/ai/backend/client/func/service.py	Updated `create` and `try_start` signatures to match the new request model parameters
changes/.fix.md	Added entry noting the `Service.create()` signature update

Comments suppressed due to low confidence (4)

src/ai/backend/client/func/service.py:118

The docstring for create doesn't list the newly added parameters (resources, resource_opts, domain_name, group_name, scaling_group, and updated expose_to_public). Please update it to reflect the signature change.

"""

src/ai/backend/client/func/service.py:244

The docstring for try_start is missing descriptions for the new required parameters; please add entries for each to match the updated signature.

Tries to start an inference session and terminates immediately.

src/ai/backend/client/func/service.py:93

New required parameters (resources, resource_opts, etc.) lack test coverage. Please add or update tests in ai.backend.test to validate these parameters for both create and try_start.

resources: Mapping[str, str | int],

src/ai/backend/client/func/service.py:92

[nitpick] These five parameters are enforced as positional-only, which may decrease readability for SDK consumers. Consider making them keyword-only to improve clarity.

/,

Copilot · 2025-05-21T06:03:41Z

changes/.fix.md

@@ -0,0 +1 @@
+Fixed client SDK method `Service.create()` signature to comply with `NewServiceRequestModel` schema


Update this changelog entry to also mention the try_start signature changes for full coverage.

Suggested change

Fixed client SDK method `Service.create()` signature to comply with `NewServiceRequestModel` schema

Fixed client SDK method `Service.create()` signature to comply with `NewServiceRequestModel` schema.

Updated `try_start` method signature to align with the latest `TryStartRequestModel` schema.

HyeockJinKim · 2025-05-21T06:14:37Z

src/ai/backend/client/func/service.py

+        /,
+        resources: Mapping[str, str | int],
+        resource_opts: Mapping[str, str | int],
+        domain_name: str,
+        group_name: str,
+        scaling_group: str,


/ is required?

Not mandatory.

Then we just change the position and take it as a keyword argument as before.

HyeockJinKim · 2025-05-21T06:15:36Z

src/ai/backend/client/func/service.py

-        resources: Optional[Mapping[str, str | int]] = None,
-        resource_opts: Optional[Mapping[str, str | int]] = None,
        cluster_size: int = 1,
        cluster_mode: Literal["single-node", "multi-node"] = "single-node",
-        domain_name: Optional[str] = None,
-        group_name: Optional[str] = None,
        bootstrap_script: Optional[str] = None,
        tag: Optional[str] = None,
        architecture: Optional[str] = DEFAULT_IMAGE_ARCH,
-        scaling_group: Optional[str] = None,
        owner_access_key: Optional[str] = None,
        model_definition_path: Optional[str] = None,
-        expose_to_public=False,


Is it guaranteed that the arguments will come from the part?

It would have never worked and raised exceptions without explicit setting arguments.

I checked. the arguments are being passed using dictionary.
that part seems fine. 👍

Copilot

Pull Request Overview

Aligns the client SDK’s Service.create() and Service.try_start() methods with the NewServiceRequestModel schema by making several parameters required and explicitly typing a boolean flag.

Made resources, resource_opts, domain_name, group_name, and scaling_group required positional parameters
Changed expose_to_public to an explicitly typed bool
Added a change log entry reflecting the updated Service.create() signature

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
src/ai/backend/client/func/service.py	Updated `create` and `try_start` signatures to enforce required parameters and typed boolean flag
changes/4449.fix.md	Added note about `Service.create()` signature fix

Comments suppressed due to low confidence (4)

src/ai/backend/client/func/service.py:116

The docstring for create() doesn’t list the newly required parameters (resources, resource_opts, domain_name, group_name, scaling_group). Please update it to describe each parameter and its type.

"""

src/ai/backend/client/func/service.py:102

The signature now enforces resources and other parameters as required; please add or update tests in ai.backend.test to cover valid calls and error cases when these parameters are omitted.

resources: Mapping[str, str | int],

src/ai/backend/client/func/service.py:99

Making parameters previously optional now required is a breaking change. Consider documenting this in the release notes and bumping the major version to signal the API change.

async def create(

changes/4449.fix.md:1

[nitpick] The change log filename (4449.fix.md) and references (fix(BA-1380): Update Service.create() to comply with validation schema #4449) don’t match the PR’s issue number (Inconsistent handling of nullable value for group_name in service creation API #4417). Consider renaming the file or updating its header for consistency.

+Fixed client SDK method `Service.create()` signature to comply with `NewServiceRequestModel` schema

HyeockJinKim · 2025-05-22T08:56:36Z

src/ai/backend/client/func/service.py

+        resources: Mapping[str, str | int],
+        resource_opts: Mapping[str, str | int],
        cluster_size: int = 1,
        cluster_mode: Literal["single-node", "multi-node"] = "single-node",
-        domain_name: Optional[str] = None,
-        group_name: Optional[str] = None,
+        domain_name: str,
+        group_name: str,
        bootstrap_script: Optional[str] = None,
        tag: Optional[str] = None,
        architecture: Optional[str] = DEFAULT_IMAGE_ARCH,
-        scaling_group: Optional[str] = None,
+        scaling_group: str,


Isn’t it the case that once a parameter is given a default value, all following parameters must also have default values? @rapsealk

Any parameter defined after * must be specified using its name (i.e., as a keyword argument). The order of these keyword-only arguments in a function call doesn't matter, since they can't be passed positionally.

Wouldn’t it be better to place keyword-only arguments without default values first for better readability and clarity. @rapsealk

This reverts commit 3d62c7b.

…ema (#4449) Co-authored-by: octodog <mu001@lablup.com> Backported-from: main (25.8) Backported-to: 25.6 Backport-of: 4449

…ema (#4449) (#4484) Co-authored-by: Jeongseok Kang <jskang@lablup.com>

rapsealk added 2 commits May 21, 2025 14:57

fix(BA-1380): Update Service.create() method signature to align wit…

865d089

…h `NewServiceRequestModel` schema

docs(BA-1380): Add news fragment

8136be0

rapsealk added this to the 25.6 milestone May 21, 2025

rapsealk requested review from kyujin-cho, HyeockJinKim and Copilot May 21, 2025 06:02

github-actions bot assigned rapsealk May 21, 2025

github-actions bot added size:S 10~30 LoC comp:client Related to Client component labels May 21, 2025

docs: Rename the news fragment with the PR number

1118285

.fix.md -> 4449.fix.md Co-authored-by: octodog <mu001@lablup.com>

Copilot AI reviewed May 21, 2025

View reviewed changes

rapsealk changed the title ~~fix(BA-1380): Update Service.create() signature in client SDK to comply with NewServiceRequestModel schema~~ fix(BA-1380): Update Service.create() to comply with validation schema May 21, 2025

HyeockJinKim reviewed May 21, 2025

View reviewed changes

Update service.py

3d62c7b

rapsealk requested a review from Copilot May 22, 2025 07:27

Copilot AI reviewed May 22, 2025

View reviewed changes

HyeockJinKim reviewed May 22, 2025

View reviewed changes

Merge branch 'main' into fix/BA-1380-client-sdk-service-create-params

18bb828

rapsealk requested a review from HyeockJinKim May 23, 2025 04:12

rapsealk added 3 commits May 23, 2025 14:46

Revert "Update service.py"

05a4ef6

This reverts commit 3d62c7b.

Update service.py

3f9de6f

Merge branch 'main' into fix/BA-1380-client-sdk-service-create-params

9a7a103

HyeockJinKim approved these changes May 23, 2025

View reviewed changes

HyeockJinKim added this pull request to the merge queue May 23, 2025

Merged via the queue into main with commit 5e28341 May 23, 2025
26 checks passed

HyeockJinKim deleted the fix/BA-1380-client-sdk-service-create-params branch May 23, 2025 06:51

lablup-octodog added a commit that referenced this pull request May 23, 2025

fix(BA-1380): Update Service.create() to comply with validation sch…

a2a33bb

…ema (#4449) Co-authored-by: octodog <mu001@lablup.com> Backported-from: main (25.8) Backported-to: 25.6 Backport-of: 4449

lablup-octodog mentioned this pull request May 23, 2025

fix(BA-1380): Update Service.create() to comply with validation schema (#4449) #4484

Merged

github-merge-queue bot pushed a commit that referenced this pull request May 23, 2025

fix(BA-1380): Update Service.create() to comply with validation sch…

6b32562

…ema (#4449) (#4484) Co-authored-by: Jeongseok Kang <jskang@lablup.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(BA-1380): Update `Service.create()` to comply with validation schema #4449

fix(BA-1380): Update `Service.create()` to comply with validation schema #4449

Uh oh!

rapsealk commented May 21, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI May 21, 2025

Uh oh!

HyeockJinKim May 21, 2025

Uh oh!

rapsealk May 21, 2025

Uh oh!

HyeockJinKim May 21, 2025

Uh oh!

HyeockJinKim May 21, 2025

Uh oh!

rapsealk May 21, 2025

Uh oh!

HyeockJinKim May 21, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

HyeockJinKim May 22, 2025

Uh oh!

rapsealk May 22, 2025

Uh oh!

HyeockJinKim May 23, 2025

Uh oh!

Uh oh!

Uh oh!

		@@ -0,0 +1 @@
		Fixed client SDK method `Service.create()` signature to comply with `NewServiceRequestModel` schema

	Fixed client SDK method `Service.create()` signature to comply with `NewServiceRequestModel` schema
	Fixed client SDK method `Service.create()` signature to comply with `NewServiceRequestModel` schema.
	Updated `try_start` method signature to align with the latest `TryStartRequestModel` schema.

fix(BA-1380): Update Service.create() to comply with validation schema #4449

fix(BA-1380): Update Service.create() to comply with validation schema #4449

Uh oh!

Conversation

rapsealk commented May 21, 2025

SDK Method Signature Updates:

Parameter Adjustments in Service Methods:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 21, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fix(BA-1380): Update `Service.create()` to comply with validation schema #4449

fix(BA-1380): Update `Service.create()` to comply with validation schema #4449