Skip to content

Commit fee7b89

Browse files
Ark-kunArk-kun
committed
Implemented the reviewer request: Removed the Optional[str] annotations where default value cannot be specified
1 parent 57b1241 commit fee7b89

File tree

4 files changed

+24
-21
lines changed

4 files changed

+24
-21
lines changed

‎google/cloud/aiplatform/datasets/dataset.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,8 @@ def _validate_metadata_schema_uri(self) -> None:
106106
@classmethod
107107
def create(
108108
cls,
109-
display_name: Optional[str],
109+
# TODO(b/223262536): Make the display_name parameter optional in the next major release
110+
display_name: str,
110111
metadata_schema_uri: str,
111112
gcs_source: Optional[Union[str, Sequence[str]]] = None,
112113
bq_source: Optional[str] = None,

‎google/cloud/aiplatform/jobs.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,8 @@ def completion_stats(self) -> Optional[gca_completion_stats.CompletionStats]:
344344
@classmethod
345345
def create(
346346
cls,
347-
job_display_name: Optional[str],
347+
# TODO(b/223262536): Make the job_display_name parameter optional in the next major release
348+
job_display_name: str,
348349
model_name: Union[str, "aiplatform.Model"],
349350
instances_format: str = "jsonl",
350351
predictions_format: str = "jsonl",
@@ -374,7 +375,7 @@ def create(
374375
375376
Args:
376377
job_display_name (str):
377-
Optional. The user-defined name of the BatchPredictionJob.
378+
Required. The user-defined name of the BatchPredictionJob.
378379
The name can be up to 128 characters long and can be consist
379380
of any UTF-8 characters.
380381
model_name (Union[str, aiplatform.Model]):
@@ -1013,7 +1014,7 @@ class CustomJob(_RunnableJob):
10131014
def __init__(
10141015
self,
10151016
# TODO(b/223262536): Make display_name parameter fully optional in next major release
1016-
display_name: Optional[str],
1017+
display_name: str,
10171018
worker_pool_specs: Union[List[Dict], List[aiplatform.gapic.WorkerPoolSpec]],
10181019
base_output_dir: Optional[str] = None,
10191020
project: Optional[str] = None,
@@ -1059,7 +1060,7 @@ def __init__(
10591060
10601061
Args:
10611062
display_name (str):
1062-
Optional. The user-defined name of the HyperparameterTuningJob.
1063+
Required. The user-defined name of the HyperparameterTuningJob.
10631064
The name can be up to 128 characters long and can be consist
10641065
of any UTF-8 characters.
10651066
worker_pool_specs (Union[List[Dict], List[aiplatform.gapic.WorkerPoolSpec]]):
@@ -1173,7 +1174,7 @@ def _log_web_access_uris(self):
11731174
def from_local_script(
11741175
cls,
11751176
# TODO(b/223262536): Make display_name parameter fully optional in next major release
1176-
display_name: Optional[str],
1177+
display_name: str,
11771178
script_path: str,
11781179
container_uri: str,
11791180
args: Optional[Sequence[str]] = None,
@@ -1216,7 +1217,7 @@ def from_local_script(
12161217
12171218
Args:
12181219
display_name (str):
1219-
Optional. The user-defined name of this CustomJob.
1220+
Required. The user-defined name of this CustomJob.
12201221
script_path (str):
12211222
Required. Local path to training script.
12221223
container_uri (str):
@@ -1493,7 +1494,7 @@ class HyperparameterTuningJob(_RunnableJob):
14931494
def __init__(
14941495
self,
14951496
# TODO(b/223262536): Make display_name parameter fully optional in next major release
1496-
display_name: Optional[str],
1497+
display_name: str,
14971498
custom_job: CustomJob,
14981499
metric_spec: Dict[str, str],
14991500
parameter_spec: Dict[str, hyperparameter_tuning._ParameterSpec],
@@ -1567,7 +1568,7 @@ def __init__(
15671568
15681569
Args:
15691570
display_name (str):
1570-
Optional. The user-defined name of the HyperparameterTuningJob.
1571+
Required. The user-defined name of the HyperparameterTuningJob.
15711572
The name can be up to 128 characters long and can be consist
15721573
of any UTF-8 characters.
15731574
custom_job (aiplatform.CustomJob):

‎google/cloud/aiplatform/pipeline_jobs.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,9 @@ class PipelineJob(base.VertexAiResourceNounWithFutureManager):
8989

9090
def __init__(
9191
self,
92+
# TODO(b/223262536): Make the display_name parameter optional in the next major release
93+
display_name: str,
9294
template_path: str,
93-
display_name: Optional[str],
9495
job_id: Optional[str] = None,
9596
pipeline_root: Optional[str] = None,
9697
parameter_values: Optional[Dict[str, Any]] = None,
@@ -106,7 +107,7 @@ def __init__(
106107
107108
Args:
108109
display_name (str):
109-
Optional. The user-defined name of this Pipeline.
110+
Required. The user-defined name of this Pipeline.
110111
template_path (str):
111112
Required. The path of PipelineJob or PipelineSpec JSON file. It
112113
can be a local path or a Google Cloud Storage URI.

‎google/cloud/aiplatform/training_jobs.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1016,7 +1016,7 @@ class _CustomTrainingJob(_TrainingJob):
10161016
def __init__(
10171017
self,
10181018
# TODO(b/223262536): Make display_name parameter fully optional in next major release
1019-
display_name: Optional[str],
1019+
display_name: str,
10201020
container_uri: str,
10211021
model_serving_container_image_uri: Optional[str] = None,
10221022
model_serving_container_predict_route: Optional[str] = None,
@@ -1040,7 +1040,7 @@ def __init__(
10401040
"""
10411041
Args:
10421042
display_name (str):
1043-
Optional. The user-defined name of this TrainingPipeline.
1043+
Required. The user-defined name of this TrainingPipeline.
10441044
container_uri (str):
10451045
Required: Uri of the training container image in the GCR.
10461046
model_serving_container_image_uri (str):
@@ -1556,7 +1556,7 @@ class CustomTrainingJob(_CustomTrainingJob):
15561556
def __init__(
15571557
self,
15581558
# TODO(b/223262536): Make display_name parameter fully optional in next major release
1559-
display_name: Optional[str],
1559+
display_name: str,
15601560
script_path: str,
15611561
container_uri: str,
15621562
requirements: Optional[Sequence[str]] = None,
@@ -1616,7 +1616,7 @@ def __init__(
16161616
16171617
Args:
16181618
display_name (str):
1619-
Optional. The user-defined name of this TrainingPipeline.
1619+
Required. The user-defined name of this TrainingPipeline.
16201620
script_path (str): Required. Local path to training script.
16211621
container_uri (str):
16221622
Required: Uri of the training container image in the GCR.
@@ -2388,7 +2388,7 @@ class CustomContainerTrainingJob(_CustomTrainingJob):
23882388
def __init__(
23892389
self,
23902390
# TODO(b/223262536): Make display_name parameter fully optional in next major release
2391-
display_name: Optional[str],
2391+
display_name: str,
23922392
container_uri: str,
23932393
command: Sequence[str] = None,
23942394
model_serving_container_image_uri: Optional[str] = None,
@@ -2446,7 +2446,7 @@ def __init__(
24462446
24472447
Args:
24482448
display_name (str):
2449-
Optional. The user-defined name of this TrainingPipeline.
2449+
Required. The user-defined name of this TrainingPipeline.
24502450
container_uri (str):
24512451
Required: Uri of the training container image in the GCR.
24522452
command (Sequence[str]):
@@ -3197,7 +3197,7 @@ class AutoMLTabularTrainingJob(_TrainingJob):
31973197
def __init__(
31983198
self,
31993199
# TODO(b/223262536): Make display_name parameter fully optional in next major release
3200-
display_name: Optional[str],
3200+
display_name: str,
32013201
optimization_prediction_type: str,
32023202
optimization_objective: Optional[str] = None,
32033203
column_specs: Optional[Dict[str, str]] = None,
@@ -3225,7 +3225,7 @@ def __init__(
32253225
32263226
Args:
32273227
display_name (str):
3228-
Optional. The user-defined name of this TrainingPipeline.
3228+
Required. The user-defined name of this TrainingPipeline.
32293229
optimization_prediction_type (str):
32303230
The type of prediction the Model is to produce.
32313231
"classification" - Predict one out of multiple target values is
@@ -5005,7 +5005,7 @@ class CustomPythonPackageTrainingJob(_CustomTrainingJob):
50055005
def __init__(
50065006
self,
50075007
# TODO(b/223262536): Make display_name parameter fully optional in next major release
5008-
display_name: Optional[str],
5008+
display_name: str,
50095009
python_package_gcs_uri: str,
50105010
python_module_name: str,
50115011
container_uri: str,
@@ -6177,7 +6177,7 @@ class AutoMLTextTrainingJob(_TrainingJob):
61776177
def __init__(
61786178
self,
61796179
# TODO(b/223262536): Make display_name parameter fully optional in next major release
6180-
display_name: Optional[str],
6180+
display_name: str,
61816181
prediction_type: str,
61826182
multi_label: bool = False,
61836183
sentiment_max: int = 10,

0 commit comments

Comments
 (0)