Skip to content

Commit 7b1b39b

Browse files
authored
fix(sdk): Fix type annotation for train method's trainer parameter (#2646)
* SDK: Fix type annotation of `train` method's `trainer` parameter Signed-off-by: Eoin Fennessy <efenness@redhat.com> * Use `Optional[Union[...]] = None` Signed-off-by: Eoin Fennessy <efenness@redhat.com> --------- Signed-off-by: Eoin Fennessy <efenness@redhat.com>
1 parent 0d60fbc commit 7b1b39b

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

sdk/kubeflow/trainer/api/trainer_client.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
import random
1919
import string
2020
import uuid
21-
from typing import Dict, List, Optional
21+
from typing import Dict, List, Optional, Union
2222

2323
import kubeflow.trainer.models as models
2424
from kubeflow.trainer.constants import constants
@@ -153,20 +153,21 @@ def train(
153153
self,
154154
runtime: types.Runtime = types.DEFAULT_RUNTIME,
155155
initializer: Optional[types.Initializer] = None,
156-
trainer: Optional[types.CustomTrainer] = None,
156+
trainer: Optional[Union[types.CustomTrainer, types.BuiltinTrainer]] = None,
157157
) -> str:
158158
"""
159159
Create the TrainJob. You can configure these types of training task:
160160
161161
- Custom Training Task: Training with a self-contained function that encapsulates
162162
the entire model training process, e.g. `CustomTrainer`.
163+
- Builtin Training Task: Configures a post-training job using torchtune.
163164
164165
Args:
165166
runtime (`types.Runtime`): Reference to one of existing Runtimes.
166167
initializer (`Optional[types.Initializer]`):
167168
Configuration for the dataset and model initializers.
168-
trainer (`Optional[types.CustomTrainer]`):
169-
Configuration for Custom Training Task.
169+
trainer (`Union[types.CustomTrainer, types.BuiltinTrainer, None]`):
170+
Configuration for Custom or Builtin Training Task.
170171
171172
Returns:
172173
str: The unique name of the TrainJob that has been generated.

0 commit comments

Comments
 (0)