Skip to content

Commit 2508d11

Browse files
Ark-kunArk-kun
committed
feat: Made display_name optional for most calls
1 parent 8cb4839 commit 2508d11

File tree

11 files changed

+111
-51
lines changed

11 files changed

+111
-51
lines changed

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
# limitations under the License.
1616
#
1717

18+
import datetime
1819
from typing import Dict, List, Optional, Sequence, Tuple, Union
1920

2021
from google.api_core import operation
@@ -105,12 +106,12 @@ def _validate_metadata_schema_uri(self) -> None:
105106
@classmethod
106107
def create(
107108
cls,
108-
display_name: str,
109109
metadata_schema_uri: str,
110110
gcs_source: Optional[Union[str, Sequence[str]]] = None,
111111
bq_source: Optional[str] = None,
112112
import_schema_uri: Optional[str] = None,
113113
data_item_labels: Optional[Dict] = None,
114+
display_name: Optional[str] = None,
114115
project: Optional[str] = None,
115116
location: Optional[str] = None,
116117
credentials: Optional[auth_credentials.Credentials] = None,
@@ -124,7 +125,7 @@ def create(
124125
125126
Args:
126127
display_name (str):
127-
Required. The user-defined name of the Dataset.
128+
Optional. The user-defined name of the Dataset.
128129
The name can be up to 128 characters long and can be consist
129130
of any UTF-8 characters.
130131
metadata_schema_uri (str):
@@ -207,7 +208,8 @@ def create(
207208
dataset (Dataset):
208209
Instantiated representation of the managed dataset resource.
209210
"""
210-
211+
if not display_name:
212+
display_name = cls.name + " " + datetime.datetime.now().isoformat(sep=" ")
211213
utils.validate_display_name(display_name)
212214
if labels:
213215
utils.validate_labels(labels)

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
# limitations under the License.
1616
#
1717

18+
import datetime
1819
from typing import Dict, Optional, Sequence, Tuple, Union
1920

2021
from google.auth import credentials as auth_credentials
@@ -36,7 +37,7 @@ class ImageDataset(datasets._Dataset):
3637
@classmethod
3738
def create(
3839
cls,
39-
display_name: str,
40+
display_name: Optional[str] = None,
4041
gcs_source: Optional[Union[str, Sequence[str]]] = None,
4142
import_schema_uri: Optional[str] = None,
4243
data_item_labels: Optional[Dict] = None,
@@ -53,7 +54,7 @@ def create(
5354
5455
Args:
5556
display_name (str):
56-
Required. The user-defined name of the Dataset.
57+
Optional. The user-defined name of the Dataset.
5758
The name can be up to 128 characters long and can be consist
5859
of any UTF-8 characters.
5960
gcs_source (Union[str, Sequence[str]]):
@@ -126,6 +127,8 @@ def create(
126127
image_dataset (ImageDataset):
127128
Instantiated representation of the managed image dataset resource.
128129
"""
130+
if not display_name:
131+
display_name = cls.name + " " + datetime.datetime.now().isoformat(sep=" ")
129132

130133
utils.validate_display_name(display_name)
131134
if labels:

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
# limitations under the License.
1616
#
1717

18+
import datetime
1819
from typing import Dict, Optional, Sequence, Tuple, Union
1920

2021
from google.auth import credentials as auth_credentials
@@ -36,7 +37,7 @@ class TabularDataset(datasets._ColumnNamesDataset):
3637
@classmethod
3738
def create(
3839
cls,
39-
display_name: str,
40+
display_name: Optional[str] = None,
4041
gcs_source: Optional[Union[str, Sequence[str]]] = None,
4142
bq_source: Optional[str] = None,
4243
project: Optional[str] = None,
@@ -51,7 +52,7 @@ def create(
5152
5253
Args:
5354
display_name (str):
54-
Required. The user-defined name of the Dataset.
55+
Optional. The user-defined name of the Dataset.
5556
The name can be up to 128 characters long and can be consist
5657
of any UTF-8 characters.
5758
gcs_source (Union[str, Sequence[str]]):
@@ -107,7 +108,8 @@ def create(
107108
tabular_dataset (TabularDataset):
108109
Instantiated representation of the managed tabular dataset resource.
109110
"""
110-
111+
if not display_name:
112+
display_name = cls.name + " " + datetime.datetime.now().isoformat(sep=" ")
111113
utils.validate_display_name(display_name)
112114
if labels:
113115
utils.validate_labels(labels)

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
# limitations under the License.
1616
#
1717

18+
import datetime
1819
from typing import Dict, Optional, Sequence, Tuple, Union
1920

2021
from google.auth import credentials as auth_credentials
@@ -36,7 +37,7 @@ class TextDataset(datasets._Dataset):
3637
@classmethod
3738
def create(
3839
cls,
39-
display_name: str,
40+
display_name: Optional[str] = None,
4041
gcs_source: Optional[Union[str, Sequence[str]]] = None,
4142
import_schema_uri: Optional[str] = None,
4243
data_item_labels: Optional[Dict] = None,
@@ -60,7 +61,7 @@ def create(
6061
6162
Args:
6263
display_name (str):
63-
Required. The user-defined name of the Dataset.
64+
Optional. The user-defined name of the Dataset.
6465
The name can be up to 128 characters long and can be consist
6566
of any UTF-8 characters.
6667
gcs_source (Union[str, Sequence[str]]):
@@ -133,7 +134,8 @@ def create(
133134
text_dataset (TextDataset):
134135
Instantiated representation of the managed text dataset resource.
135136
"""
136-
137+
if not display_name:
138+
display_name = cls.name + " " + datetime.datetime.now().isoformat(sep=" ")
137139
utils.validate_display_name(display_name)
138140
if labels:
139141
utils.validate_labels(labels)

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
# limitations under the License.
1616
#
1717

18+
import datetime
1819
from typing import Dict, Optional, Sequence, Tuple, Union
1920

2021
from google.auth import credentials as auth_credentials
@@ -36,7 +37,7 @@ class TimeSeriesDataset(datasets._ColumnNamesDataset):
3637
@classmethod
3738
def create(
3839
cls,
39-
display_name: str,
40+
display_name: Optional[str] = None,
4041
gcs_source: Optional[Union[str, Sequence[str]]] = None,
4142
bq_source: Optional[str] = None,
4243
project: Optional[str] = None,
@@ -51,7 +52,7 @@ def create(
5152
5253
Args:
5354
display_name (str):
54-
Required. The user-defined name of the Dataset.
55+
Optional. The user-defined name of the Dataset.
5556
The name can be up to 128 characters long and can be consist
5657
of any UTF-8 characters.
5758
gcs_source (Union[str, Sequence[str]]):
@@ -108,7 +109,8 @@ def create(
108109
Instantiated representation of the managed time series dataset resource.
109110
110111
"""
111-
112+
if not display_name:
113+
display_name = cls.name + " " + datetime.datetime.now().isoformat(sep=" ")
112114
utils.validate_display_name(display_name)
113115
if labels:
114116
utils.validate_labels(labels)

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
# limitations under the License.
1616
#
1717

18+
import datetime
1819
from typing import Dict, Optional, Sequence, Tuple, Union
1920

2021
from google.auth import credentials as auth_credentials
@@ -36,7 +37,7 @@ class VideoDataset(datasets._Dataset):
3637
@classmethod
3738
def create(
3839
cls,
39-
display_name: str,
40+
display_name: Optional[str] = None,
4041
gcs_source: Optional[Union[str, Sequence[str]]] = None,
4142
import_schema_uri: Optional[str] = None,
4243
data_item_labels: Optional[Dict] = None,
@@ -53,7 +54,7 @@ def create(
5354
5455
Args:
5556
display_name (str):
56-
Required. The user-defined name of the Dataset.
57+
Optional. The user-defined name of the Dataset.
5758
The name can be up to 128 characters long and can be consist
5859
of any UTF-8 characters.
5960
gcs_source (Union[str, Sequence[str]]):
@@ -126,7 +127,8 @@ def create(
126127
video_dataset (VideoDataset):
127128
Instantiated representation of the managed video dataset resource.
128129
"""
129-
130+
if not display_name:
131+
display_name = cls.name + " " + datetime.datetime.now().isoformat(sep=" ")
130132
utils.validate_display_name(display_name)
131133
if labels:
132134
utils.validate_labels(labels)

‎google/cloud/aiplatform/jobs.py

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -966,9 +966,9 @@ class CustomJob(_RunnableJob):
966966

967967
def __init__(
968968
self,
969-
display_name: str,
970969
worker_pool_specs: Union[List[Dict], List[aiplatform.gapic.WorkerPoolSpec]],
971970
base_output_dir: Optional[str] = None,
971+
display_name: Optional[str] = None,
972972
project: Optional[str] = None,
973973
location: Optional[str] = None,
974974
credentials: Optional[auth_credentials.Credentials] = None,
@@ -1012,7 +1012,7 @@ def __init__(
10121012
10131013
Args:
10141014
display_name (str):
1015-
Required. The user-defined name of the HyperparameterTuningJob.
1015+
Optional. The user-defined name of the HyperparameterTuningJob.
10161016
The name can be up to 128 characters long and can be consist
10171017
of any UTF-8 characters.
10181018
worker_pool_specs (Union[List[Dict], List[aiplatform.gapic.WorkerPoolSpec]]):
@@ -1070,6 +1070,9 @@ def __init__(
10701070
staging_bucket, "aiplatform-custom-job"
10711071
)
10721072

1073+
if not display_name:
1074+
display_name = self.__class__.name + " " + datetime.datetime.now().isoformat(sep=" ")
1075+
10731076
self._gca_resource = gca_custom_job_compat.CustomJob(
10741077
display_name=display_name,
10751078
job_spec=gca_custom_job_compat.CustomJobSpec(
@@ -1122,7 +1125,6 @@ def _log_web_access_uris(self):
11221125
@classmethod
11231126
def from_local_script(
11241127
cls,
1125-
display_name: str,
11261128
script_path: str,
11271129
container_uri: str,
11281130
args: Optional[Sequence[str]] = None,
@@ -1138,6 +1140,7 @@ def from_local_script(
11381140
reduction_server_machine_type: Optional[str] = None,
11391141
reduction_server_container_uri: Optional[str] = None,
11401142
base_output_dir: Optional[str] = None,
1143+
display_name: Optional[str] = None,
11411144
project: Optional[str] = None,
11421145
location: Optional[str] = None,
11431146
credentials: Optional[auth_credentials.Credentials] = None,
@@ -1165,7 +1168,7 @@ def from_local_script(
11651168
11661169
Args:
11671170
display_name (str):
1168-
Required. The user-defined name of this CustomJob.
1171+
Optional. The user-defined name of this CustomJob.
11691172
script_path (str):
11701173
Required. Local path to training script.
11711174
container_uri (str):
@@ -1439,7 +1442,6 @@ class HyperparameterTuningJob(_RunnableJob):
14391442

14401443
def __init__(
14411444
self,
1442-
display_name: str,
14431445
custom_job: CustomJob,
14441446
metric_spec: Dict[str, str],
14451447
parameter_spec: Dict[str, hyperparameter_tuning._ParameterSpec],
@@ -1448,6 +1450,7 @@ def __init__(
14481450
max_failed_trial_count: int = 0,
14491451
search_algorithm: Optional[str] = None,
14501452
measurement_selection: Optional[str] = "best",
1453+
display_name: Optional[str] = None,
14511454
project: Optional[str] = None,
14521455
location: Optional[str] = None,
14531456
credentials: Optional[auth_credentials.Credentials] = None,
@@ -1513,7 +1516,7 @@ def __init__(
15131516
15141517
Args:
15151518
display_name (str):
1516-
Required. The user-defined name of the HyperparameterTuningJob.
1519+
Optional. The user-defined name of the HyperparameterTuningJob.
15171520
The name can be up to 128 characters long and can be consist
15181521
of any UTF-8 characters.
15191522
custom_job (aiplatform.CustomJob):
@@ -1635,6 +1638,9 @@ def __init__(
16351638
],
16361639
)
16371640

1641+
if not display_name:
1642+
display_name = self.__class__.name + " " + datetime.datetime.now().isoformat(sep=" ")
1643+
16381644
self._gca_resource = gca_hyperparameter_tuning_job_compat.HyperparameterTuningJob(
16391645
display_name=display_name,
16401646
study_spec=study_spec,

0 commit comments

Comments
 (0)