feat: Made display_name parameter optional for most calls

google/cloud/aiplatform/base.py

@@ -673,6 +673,13 @@ def to_dict(self) -> Dict[str, Any]:
         """Returns the resource proto as a dictionary."""
         return json_format.MessageToDict(self.gca_resource._pb)
 
+    @classmethod
+    def _generate_display_name(cls, prefix: Optional[str] = None) -> str:
+        """Returns a display name containing class name and time string."""
+        if not prefix:
+            prefix = cls.__name__
+        return prefix + " " + datetime.datetime.now().isoformat(sep=" ")
+
 
 def optional_sync(
     construct_object_on_arg: Optional[str] = None,

google/cloud/aiplatform/datasets/dataset.py

@@ -125,7 +125,7 @@ def create(
 
         Args:
             display_name (str):
-                Required. The user-defined name of the Dataset.
+                Optional. The user-defined name of the Dataset.
                 The name can be up to 128 characters long and can be consist
                 of any UTF-8 characters.
             metadata_schema_uri (str):
@@ -208,7 +208,8 @@ def create(
             dataset (Dataset):
                 Instantiated representation of the managed dataset resource.
         """
-
+        if not display_name:
+            display_name = cls._generate_display_name()
         utils.validate_display_name(display_name)
         if labels:
             utils.validate_labels(labels)

google/cloud/aiplatform/datasets/image_dataset.py

@@ -36,7 +36,7 @@ class ImageDataset(datasets._Dataset):
     @classmethod
     def create(
         cls,
-        display_name: str,
+        display_name: Optional[str] = None,
         gcs_source: Optional[Union[str, Sequence[str]]] = None,
         import_schema_uri: Optional[str] = None,
         data_item_labels: Optional[Dict] = None,
@@ -53,7 +53,7 @@ def create(
 
         Args:
             display_name (str):
-                Required. The user-defined name of the Dataset.
+                Optional. The user-defined name of the Dataset.
                 The name can be up to 128 characters long and can be consist
                 of any UTF-8 characters.
             gcs_source (Union[str, Sequence[str]]):
@@ -126,6 +126,8 @@ def create(
             image_dataset (ImageDataset):
                 Instantiated representation of the managed image dataset resource.
         """
+        if not display_name:
+            display_name = cls._generate_display_name()
 
         utils.validate_display_name(display_name)
         if labels:

google/cloud/aiplatform/datasets/tabular_dataset.py

@@ -36,7 +36,7 @@ class TabularDataset(datasets._ColumnNamesDataset):
     @classmethod
     def create(
         cls,
-        display_name: str,
+        display_name: Optional[str] = None,
         gcs_source: Optional[Union[str, Sequence[str]]] = None,
         bq_source: Optional[str] = None,
         project: Optional[str] = None,
@@ -51,7 +51,7 @@ def create(
 
         Args:
             display_name (str):
-                Required. The user-defined name of the Dataset.
+                Optional. The user-defined name of the Dataset.
                 The name can be up to 128 characters long and can be consist
                 of any UTF-8 characters.
             gcs_source (Union[str, Sequence[str]]):
@@ -107,7 +107,8 @@ def create(
             tabular_dataset (TabularDataset):
                 Instantiated representation of the managed tabular dataset resource.
         """
-
+        if not display_name:
+            display_name = cls._generate_display_name()
         utils.validate_display_name(display_name)
         if labels:
             utils.validate_labels(labels)

google/cloud/aiplatform/datasets/text_dataset.py

@@ -36,7 +36,7 @@ class TextDataset(datasets._Dataset):
     @classmethod
     def create(
         cls,
-        display_name: str,
+        display_name: Optional[str] = None,
         gcs_source: Optional[Union[str, Sequence[str]]] = None,
         import_schema_uri: Optional[str] = None,
         data_item_labels: Optional[Dict] = None,
@@ -60,7 +60,7 @@ def create(
 
         Args:
             display_name (str):
-                Required. The user-defined name of the Dataset.
+                Optional. The user-defined name of the Dataset.
                 The name can be up to 128 characters long and can be consist
                 of any UTF-8 characters.
             gcs_source (Union[str, Sequence[str]]):
@@ -133,7 +133,8 @@ def create(
             text_dataset (TextDataset):
                 Instantiated representation of the managed text dataset resource.
         """
-
+        if not display_name:
+            display_name = cls._generate_display_name()
         utils.validate_display_name(display_name)
         if labels:
             utils.validate_labels(labels)

google/cloud/aiplatform/datasets/time_series_dataset.py

@@ -36,7 +36,7 @@ class TimeSeriesDataset(datasets._ColumnNamesDataset):
     @classmethod
     def create(
         cls,
-        display_name: str,
+        display_name: Optional[str] = None,
         gcs_source: Optional[Union[str, Sequence[str]]] = None,
         bq_source: Optional[str] = None,
         project: Optional[str] = None,
@@ -51,7 +51,7 @@ def create(
 
         Args:
             display_name (str):
-                Required. The user-defined name of the Dataset.
+                Optional. The user-defined name of the Dataset.
                 The name can be up to 128 characters long and can be consist
                 of any UTF-8 characters.
             gcs_source (Union[str, Sequence[str]]):
@@ -108,7 +108,8 @@ def create(
                 Instantiated representation of the managed time series dataset resource.
 
         """
-
+        if not display_name:
+            display_name = cls._generate_display_name()
         utils.validate_display_name(display_name)
         if labels:
             utils.validate_labels(labels)

google/cloud/aiplatform/datasets/video_dataset.py

@@ -36,7 +36,7 @@ class VideoDataset(datasets._Dataset):
     @classmethod
     def create(
         cls,
-        display_name: str,
+        display_name: Optional[str] = None,
         gcs_source: Optional[Union[str, Sequence[str]]] = None,
         import_schema_uri: Optional[str] = None,
         data_item_labels: Optional[Dict] = None,
@@ -53,7 +53,7 @@ def create(
 
         Args:
             display_name (str):
-                Required. The user-defined name of the Dataset.
+                Optional. The user-defined name of the Dataset.
                 The name can be up to 128 characters long and can be consist
                 of any UTF-8 characters.
             gcs_source (Union[str, Sequence[str]]):
@@ -126,7 +126,8 @@ def create(
             video_dataset (VideoDataset):
                 Instantiated representation of the managed video dataset resource.
         """
-
+        if not display_name:
+            display_name = cls._generate_display_name()
         utils.validate_display_name(display_name)
         if labels:
             utils.validate_labels(labels)

google/cloud/aiplatform/jobs.py

@@ -344,7 +344,7 @@ def completion_stats(self) -> Optional[gca_completion_stats.CompletionStats]:
     @classmethod
     def create(
         cls,
-        job_display_name: str,
+        job_display_name: Optional[str],
         model_name: Union[str, "aiplatform.Model"],
         instances_format: str = "jsonl",
         predictions_format: str = "jsonl",
@@ -374,7 +374,7 @@ def create(
 
         Args:
             job_display_name (str):
-                Required. The user-defined name of the BatchPredictionJob.
+                Optional. The user-defined name of the BatchPredictionJob.
                 The name can be up to 128 characters long and can be consist
                 of any UTF-8 characters.
             model_name (Union[str, aiplatform.Model]):
@@ -527,6 +527,8 @@ def create(
             (jobs.BatchPredictionJob):
                 Instantiated representation of the created batch prediction job.
         """
+        if not job_display_name:
+            job_display_name = cls._generate_display_name()
 
         utils.validate_display_name(job_display_name)
 
@@ -977,9 +979,9 @@ class CustomJob(_RunnableJob):
 
     def __init__(
         self,
-        display_name: str,
         worker_pool_specs: Union[List[Dict], List[aiplatform.gapic.WorkerPoolSpec]],
         base_output_dir: Optional[str] = None,
+        display_name: Optional[str] = None,
         project: Optional[str] = None,
         location: Optional[str] = None,
         credentials: Optional[auth_credentials.Credentials] = None,
@@ -1023,7 +1025,7 @@ def __init__(
 
         Args:
             display_name (str):
-                Required. The user-defined name of the HyperparameterTuningJob.
+                Optional. The user-defined name of the HyperparameterTuningJob.
                 The name can be up to 128 characters long and can be consist
                 of any UTF-8 characters.
             worker_pool_specs (Union[List[Dict], List[aiplatform.gapic.WorkerPoolSpec]]):
@@ -1081,6 +1083,9 @@ def __init__(
             staging_bucket, "aiplatform-custom-job"
         )
 
+        if not display_name:
+            display_name = self.__class__._generate_display_name()
+
         self._gca_resource = gca_custom_job_compat.CustomJob(
             display_name=display_name,
             job_spec=gca_custom_job_compat.CustomJobSpec(
@@ -1133,7 +1138,6 @@ def _log_web_access_uris(self):
     @classmethod
     def from_local_script(
         cls,
-        display_name: str,
         script_path: str,
         container_uri: str,
         args: Optional[Sequence[str]] = None,
@@ -1149,6 +1153,7 @@ def from_local_script(
         reduction_server_machine_type: Optional[str] = None,
         reduction_server_container_uri: Optional[str] = None,
         base_output_dir: Optional[str] = None,
+        display_name: Optional[str] = None,
         project: Optional[str] = None,
         location: Optional[str] = None,
         credentials: Optional[auth_credentials.Credentials] = None,
@@ -1176,7 +1181,7 @@ def from_local_script(
 
         Args:
             display_name (str):
-                Required. The user-defined name of this CustomJob.
+                Optional. The user-defined name of this CustomJob.
             script_path (str):
                 Required. Local path to training script.
             container_uri (str):
@@ -1452,7 +1457,6 @@ class HyperparameterTuningJob(_RunnableJob):
 
     def __init__(
         self,
-        display_name: str,
         custom_job: CustomJob,
         metric_spec: Dict[str, str],
         parameter_spec: Dict[str, hyperparameter_tuning._ParameterSpec],
@@ -1461,6 +1465,7 @@ def __init__(
         max_failed_trial_count: int = 0,
         search_algorithm: Optional[str] = None,
         measurement_selection: Optional[str] = "best",
+        display_name: Optional[str] = None,
         project: Optional[str] = None,
         location: Optional[str] = None,
         credentials: Optional[auth_credentials.Credentials] = None,
@@ -1526,7 +1531,7 @@ def __init__(
 
         Args:
             display_name (str):
-                Required. The user-defined name of the HyperparameterTuningJob.
+                Optional. The user-defined name of the HyperparameterTuningJob.
                 The name can be up to 128 characters long and can be consist
                 of any UTF-8 characters.
             custom_job (aiplatform.CustomJob):
@@ -1648,6 +1653,9 @@ def __init__(
             ],
         )
 
+        if not display_name:
+            display_name = self.__class__._generate_display_name()
+
         self._gca_resource = gca_hyperparameter_tuning_job_compat.HyperparameterTuningJob(
             display_name=display_name,
             study_spec=study_spec,