fix(sdk): resolve errors in deserialization #2457
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…json. Signed-off-by: Electronic-Waste <[email protected]>
Comment on lines
-46
to
48
| # Import JobSet models for the serialization. It imports the Kubernetes models. | ||
| # Import Kubernetes and JobSet models for the serialization. | ||
| from kubernetes.client import * | ||
| from jobset.models import * |
There was a problem hiding this comment.
JobSet does not import Kubernetes models: https://github.com/kubernetes-sigs/jobset/blob/main/sdk/python/jobset/models/__init__.py
hack/python-sdk/swagger_config.json
Outdated
| @@ -1,6 +1,8 @@ | |||
| { | |||
| "packageName": "kubeflow.trainer", | |||
| "typeMappings": { | |||
| "K8sIoApiAutoscalingV2MetricSpec": "V2MetricSpec", | |||
| "K8sIoApimachineryPkgUtilIntstrIntOrString": "Union[int, str]", | |||
There was a problem hiding this comment.
Should we use Union[int, str] or object here since Union is not a standard type ?
There was a problem hiding this comment.
I've tried both options. And I found that Union[int, str] cannot be deserialized since it's not a standard type:
Traceback (most recent call last):
File "/home/ws/miniconda3/envs/training-operator/lib/python3.11/site-packages/kubeflow/trainer/api/trainer_client.py", line 103, in list_runtimes
runtime = self.api_client.deserialize(
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/ws/miniconda3/envs/training-operator/lib/python3.11/site-packages/kubeflow/trainer/api_client.py", line 280, in deserialize
return self.__deserialize(data, response_type)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/ws/miniconda3/envs/training-operator/lib/python3.11/site-packages/kubeflow/trainer/api_client.py", line 319, in __deserialize
return self.__deserialize_model(data, klass)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/ws/miniconda3/envs/training-operator/lib/python3.11/site-packages/kubeflow/trainer/api_client.py", line 658, in __deserialize_model
kwargs[attr] = self.__deserialize(value, attr_type)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/ws/miniconda3/envs/training-operator/lib/python3.11/site-packages/kubeflow/trainer/api_client.py", line 319, in __deserialize
return self.__deserialize_model(data, klass)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/ws/miniconda3/envs/training-operator/lib/python3.11/site-packages/kubeflow/trainer/api_client.py", line 658, in __deserialize_model
kwargs[attr] = self.__deserialize(value, attr_type)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/ws/miniconda3/envs/training-operator/lib/python3.11/site-packages/kubeflow/trainer/api_client.py", line 319, in __deserialize
return self.__deserialize_model(data, klass)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/ws/miniconda3/envs/training-operator/lib/python3.11/site-packages/kubeflow/trainer/api_client.py", line 658, in __deserialize_model
kwargs[attr] = self.__deserialize(value, attr_type)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/ws/miniconda3/envs/training-operator/lib/python3.11/site-packages/kubeflow/trainer/api_client.py", line 319, in __deserialize
return self.__deserialize_model(data, klass)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/ws/miniconda3/envs/training-operator/lib/python3.11/site-packages/kubeflow/trainer/api_client.py", line 658, in __deserialize_model
kwargs[attr] = self.__deserialize(value, attr_type)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/ws/miniconda3/envs/training-operator/lib/python3.11/site-packages/kubeflow/trainer/api_client.py", line 308, in __deserialize
klass = getattr(kubeflow.trainer.models, klass)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: module 'kubeflow.trainer.models' has no attribute 'Union[int, str]'
During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "/home/ws/kubeflow/trainer-example/list_runtime.py", line 4, in <module>
for r in TrainerClient().list_runtimes():
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/ws/miniconda3/envs/training-operator/lib/python3.11/site-packages/kubeflow/trainer/api/trainer_client.py", line 160, in list_runtimes
raise RuntimeError(
RuntimeError: Failed to list ClusterTrainingRuntimes in namespace: default
In this case, I think we should use object like what Kubernetes Python client did in: kubernetes-client/python#366
And it works well
$ python list_runtime.py
Runtime: mpi-distributed
Runtime: torch-distributedThere was a problem hiding this comment.
@andreyvelich Sorry for the confusion.
There was a problem hiding this comment.
@Electronic-Waste Yes, please let's use object there.
Signed-off-by: Electronic-Waste <[email protected]>
Electronic-Waste
force-pushed
the
fix/deserialization
branch
from
2aff571 to
3697e01
Compare
andreyvelich
reviewed
Mar 2, 2025
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: andreyvelich, astefanutti The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR fixes the error that occurred in deserialization (
sdk/kubeflow/trainer/api_client.py)I make these changes:
kubernetes.clientimport inhack/python-sdk/gen-sdk.sh/cc @kubeflow/wg-training-leads @astefanutti
Which issue(s) this PR fixes (optional, in
Fixes #<issue number>, #<issue number>, ...format, will close the issue(s) when PR gets merged):Fixes #
Checklist: