Merge pull request #1814 from wkentaro/refactor_/rename_store_data_to_with_image_data_and_default_to_false

refactor!: rename store_data to with_image_data and default to false

Author: wkentaro

README.md

@@ -98,7 +98,7 @@ labelme  # just open gui
 cd examples/tutorial
 labelme apc2016_obj3.jpg  # specify image file
 labelme apc2016_obj3.jpg --output annotations/  # save annotation JSON files to a directory
-labelme apc2016_obj3.jpg --nodata  # not include image data but relative image path in JSON file
+labelme apc2016_obj3.jpg --with-image-data  # include image data in JSON file
 labelme apc2016_obj3.jpg \
   --labels highland_6539_self_stick_notes,mead_index_cards,kong_air_dog_squeakair_tennis_ball  # specify label list
 

examples/bbox_detection/README.md

@@ -4,7 +4,7 @@
 ## Usage
 
 ```bash
-labelme data_annotated --labels labels.txt --nodata --autosave
+labelme data_annotated --labels labels.txt --autosave
 ```
 
 ![](.readme/annotation.jpg)

examples/classification/README.md

@@ -4,7 +4,7 @@
 ## Usage
 
 ```bash
-labelme data_annotated --flags flags.txt --nodata
+labelme data_annotated --flags flags.txt
 ```
 
 <img src=".readme/annotation_cat.jpg" width="100%" />

examples/instance_segmentation/README.md

@@ -3,8 +3,8 @@
 ## Annotation
 
 ```bash
-labelme data_annotated --labels labels.txt --nodata --validatelabel exact --config '{shift_auto_shape_color: -2}'
-labelme data_annotated --labels labels.txt --nodata --labelflags '{.*: [occluded, truncated], person: [male]}'
+labelme data_annotated --labels labels.txt --validatelabel exact --config '{shift_auto_shape_color: -2}'
+labelme data_annotated --labels labels.txt --labelflags '{.*: [occluded, truncated], person: [male]}'
 ```
 
 ![](.readme/annotation.jpg)

examples/semantic_segmentation/README.md

@@ -3,7 +3,7 @@
 ## Annotation
 
 ```bash
-labelme data_annotated --labels labels.txt --nodata --validatelabel exact --config '{shift_auto_shape_color: -2}'
+labelme data_annotated --labels labels.txt --validatelabel exact --config '{shift_auto_shape_color: -2}'
 ```
 
 ![](.readme/annotation.jpg)

examples/video_annotation/README.md

@@ -4,7 +4,7 @@
 ## Annotation
 
 ```bash
-labelme data_annotated --labels labels.txt --nodata --keep-prev --config '{shift_auto_shape_color: -2}'
+labelme data_annotated --labels labels.txt --keep-prev --config '{shift_auto_shape_color: -2}'
 ```
 
 <img src=".readme/00000100.jpg" width="49%" /> <img src=".readme/00000101.jpg" width="49%" />

labelme/__main__.py

@@ -122,10 +122,10 @@ def main():
     )
     # config for the gui
     parser.add_argument(
-        "--nodata",
-        dest="store_data",
-        action="store_false",
-        help="stop storing image data to JSON file",
+        "--with-image-data",
+        dest="with_image_data",
+        action="store_true",
+        help="store image data in JSON file",
         default=argparse.SUPPRESS,
     )
     parser.add_argument(

labelme/app.py

@@ -341,7 +341,7 @@ def __init__(
             slot=self.enableSaveImageWithData,
             tip=self.tr("Save image data in label file"),
             checkable=True,
-            checked=self._config["store_data"],
+            checked=self._config["with_image_data"],
         )
 
         close = action(
@@ -1522,7 +1522,7 @@ def format_shape(s):
         try:
             assert self.imagePath
             imagePath = osp.relpath(self.imagePath, osp.dirname(filename))
-            imageData = self.imageData if self._config["store_data"] else None
+            imageData = self.imageData if self._config["with_image_data"] else None
             if osp.dirname(filename) and not osp.exists(osp.dirname(filename)):
                 os.makedirs(osp.dirname(filename))
             lf.save(
@@ -1931,7 +1931,7 @@ def scaleFitWidth(self):
         return w / self.canvas.pixmap.width()
 
     def enableSaveImageWithData(self, enabled):
-        self._config["store_data"] = enabled
+        self._config["with_image_data"] = enabled
         self.actions.saveWithImageData.setChecked(enabled)
 
     def closeEvent(self, a0: QtGui.QCloseEvent) -> None:

labelme/config/__init__.py

@@ -41,6 +41,10 @@ def _migrate_config_from_file(config_from_yaml: dict) -> None:
         )
         config_from_yaml["keep_prev_brightness_contrast"] = True
 
+    if "store_data" in config_from_yaml:
+        logger.info("Migrating old config: store_data -> with_image_data")
+        config_from_yaml["with_image_data"] = config_from_yaml.pop("store_data")
+
     if config_from_yaml.get("shortcuts", {}).pop("add_point_to_edge", None):
         logger.info("Migrating old config: removing shortcuts.add_point_to_edge")
 
@@ -68,8 +72,8 @@ def get_user_config_file(create_if_missing: bool = True) -> str:
                     "#   https://github.com/wkentaro/labelme/blob/main/labelme/config/default_config.yaml\n"
                     "#\n"
                     "# Example:\n"
+                    "# with_image_data: true\n"
                     "# auto_save: true\n"
-                    "# store_data: false\n"
                     "# labels: [cat, dog]\n"
                 )
         except Exception:

labelme/config/default_config.yaml

@@ -1,6 +1,6 @@
 auto_save: false
 display_label_popup: true
-store_data: true
+with_image_data: false
 keep_prev: false
 keep_prev_scale: false
 keep_prev_brightness_contrast: false