Support dataset-cover-image.png upload for datasets metadata --update

docs/datasets_metadata.md

@@ -176,24 +176,24 @@ You can specify the following values for `expectedUpdateFrequency`:
 * `hourly`
 
 ## Images
-You can update your dataset image by providing a relative path from your `datasets-metadata.json` to an image file, using the `image` property.
+The recommended way to update your dataset's image is by placing a file named `dataset-cover-image.png` (or `.jpg`, `.jpeg`, `.webp`), as a sibling file to your `datasets-metadata.json`.
 
-For example, if your metadata file and image are located at:
+Example:
 - `/some/path/dataset-metadata.json`
-- `/some/path/image.png`
+- `/some/path/dataset-cover-image.png`
 
-This property should be specified as:
-```
-"image": "image.png"
-```
+The image file will only be used for dataset metadata, and not be uploaded as a file within your dataset.
+
+### Specifying an image with a relative path
+As an alternative, you can update your dataset image by providing a relative path from your `datasets-metadata.json` to an image file, using the `image` property.
 
-If instead, your files were located at:
+If your files were located at:
 - `/some/path/dataset-metadata.json`
-- `/some/path/alternative/path/to/other-image.jpg`
+- `/some/path/to/my-image.jpg`
 
 This property should be specified as:
 ```
-"image": "alternative/path/to/other-image.jpg"
+"image": "to/my-image.jpg"
 ```
 
 ### Supported image file types and expected dimensions

src/kaggle/api/kaggle_api_extended.py

@@ -522,6 +522,8 @@ class KaggleApi:
     HEADER_API_VERSION = "X-Kaggle-ApiVersion"
     DATASET_METADATA_FILE = "dataset-metadata.json"
     OLD_DATASET_METADATA_FILE = "datapackage.json"
+    DATASET_COVER_IMAGE_SUPPORTED_EXTENSIONS = [".png", ".jpg", ".jpeg", ".webp"]
+    DATASET_COVER_IMAGE_FILES = ["dataset-cover-image" + ext for ext in DATASET_COVER_IMAGE_SUPPORTED_EXTENSIONS]
     KERNEL_METADATA_FILE = "kernel-metadata.json"
     MODEL_METADATA_FILE = "model-metadata.json"
     MODEL_INSTANCE_METADATA_FILE = "model-instance-metadata.json"
@@ -1942,6 +1944,12 @@ def dataset_metadata_update(self, dataset, path):
                 update_settings.expected_update_frequency = expected_update_frequency
 
             effective_relative_path_to_image = metadata.get("image")
+            if not effective_relative_path_to_image:
+                # If user did not specify an image path explicitly, check if canonical images exist as siblings to dataset-metadata.json.
+                for canonical_image_filename in self.DATASET_COVER_IMAGE_FILES:
+                    canonical_image_full_path = os.path.join(effective_path, canonical_image_filename)
+                    if os.path.exists(canonical_image_full_path):
+                        effective_relative_path_to_image = canonical_image_filename
             if effective_relative_path_to_image:
                 cropped_image_upload = self._upload_dataset_image_file(effective_path, effective_relative_path_to_image)
                 if cropped_image_upload:
@@ -1962,7 +1970,7 @@ def _upload_dataset_image_file(
     ) -> CroppedImageUpload:
         image_full_path = os.path.join(metadata_file_path, relative_image_file_path)
         ext = Path(image_full_path).suffix
-        if ext not in [".jpg", ".jpeg", ".png", ".webp"]:
+        if ext not in self.DATASET_COVER_IMAGE_SUPPORTED_EXTENSIONS:
             raise ValueError("Image file requires an extension of .jpg, .jpeg, .png, or .webp: %s" % image_full_path)
 
         if not os.path.isfile(image_full_path):
@@ -4919,6 +4927,7 @@ def upload_files(
             if file_name in [
                 self.DATASET_METADATA_FILE,
                 self.OLD_DATASET_METADATA_FILE,
+                *self.DATASET_COVER_IMAGE_FILES,
                 self.KERNEL_METADATA_FILE,
                 self.MODEL_METADATA_FILE,
                 self.MODEL_INSTANCE_METADATA_FILE,

src/kaggle/cli.py

@@ -1015,9 +1015,27 @@ def parse_benchmark_tasks(subparsers) -> None:
     )
     parser_run_optional = parser_run._action_groups.pop()
     parser_run_optional.add_argument("task", help=Help.param_benchmarks_task)
-    parser_run_optional.add_argument("-m", "--model", dest="model", nargs="+", required=False, help=Help.param_benchmarks_model)
-    parser_run_optional.add_argument("--wait", dest="wait", type=int, nargs="?", const=0, default=None, required=False, help=Help.param_benchmarks_wait)
-    parser_run_optional.add_argument("--poll-interval", dest="poll_interval", type=int, default=10, required=False, help=Help.param_benchmarks_poll_interval)
+    parser_run_optional.add_argument(
+        "-m", "--model", dest="model", nargs="+", required=False, help=Help.param_benchmarks_model
+    )
+    parser_run_optional.add_argument(
+        "--wait",
+        dest="wait",
+        type=int,
+        nargs="?",
+        const=0,
+        default=None,
+        required=False,
+        help=Help.param_benchmarks_wait,
+    )
+    parser_run_optional.add_argument(
+        "--poll-interval",
+        dest="poll_interval",
+        type=int,
+        default=10,
+        required=False,
+        help=Help.param_benchmarks_poll_interval,
+    )
     parser_run._action_groups.append(parser_run_optional)
     parser_run.set_defaults(func=api.benchmarks_tasks_run_cli)