Include CH's review

Author: GwenaelleSa

examples/road-surface-classification/README.md

@@ -30,11 +30,11 @@ $ stdl-objdet make_detections config_rs.yaml
 $ stdl-objdet assess_detections config_rs.yaml
 ```
 
-The docker container is existed and the permission restored with.
+The docker container is exited and permissions restored with:
 
  ```bash
 $ exit
-$ sudo chmod -r a+w examples
+$ sudo chmod -R a+w examples
 ```
 
 This example is made up from a subset of the data used in the proj-roadsurf project. For more information about this project, you can consult [the associated repository](https://github.com/swiss-territorial-data-lab/proj-roadsurf) and [its full documentation](https://tech.stdl.ch/PROJ-ROADSURF/). <br>

helpers/misc.py

@@ -227,6 +227,14 @@ def geohash(row):
 
 
 def get_number_of_classes(coco_files_dict):
+    """Read the number of classes from the tileset COCO file.
+
+    Args:
+        coco_files_dict (dict): COCO file of the tileset
+
+    Returns:
+        num_classes (int): number of classes in the dataset
+    """
 
     file_content = open(next(iter(coco_files_dict.values())))
     coco_json = json.load(file_content)

scripts/generate_tilesets.py

@@ -150,10 +150,7 @@ def _id_to_xyz(row):
         Convert 'id' string to list of ints for x, y, z and t if eligeable
         """
 
-        try:
-            assert (row['id'].startswith('(')) & (row['id'].endswith(')')), 'The id should be surrounded by parenthesis.'
-        except AssertionError as e:
-            raise AssertionError(e)
+        assert (row['id'].startswith('(')) & (row['id'].endswith(')')), 'The id should be surrounded by parenthesis.'
 
         if 'year_tile' in row.keys(): 
             try:
@@ -281,7 +278,7 @@ def main(cfg_file_path):
     WORKING_DIR = cfg['working_directory']
     OUTPUT_DIR = cfg['output_folder']
 
-    # Get info for the download of tiles
+    # Get tile download information
     IM_SOURCE_TYPE = cfg['datasets']['image_source']['type'].upper()
     IM_SOURCE_LOCATION = cfg['datasets']['image_source']['location']
     if IM_SOURCE_TYPE != 'XYZ':
@@ -294,7 +291,7 @@ def main(cfg_file_path):
 
     AOI_TILES = cfg['datasets']['aoi_tiles']
 
-    # Get info for labels if available
+    # Get label info if available
     GT_LABELS = cfg['datasets']['ground_truth_labels'] if 'ground_truth_labels' in cfg['datasets'].keys() else None
     OTH_LABELS = cfg['datasets']['other_labels'] if 'other_labels' in cfg['datasets'].keys() else None
     FP_LABELS = cfg['datasets']['FP_labels'] if 'FP_labels' in cfg['datasets'].keys() else None
@@ -652,11 +649,7 @@ def main(cfg_file_path):
             empty_tiles_gdf = aoi_tiles_gdf[aoi_tiles_gdf.id.astype(str).isin(id_list_ept_tiles)].copy()
 
             if DEBUG_MODE:
-                try:
-                    assert(len(empty_tiles_gdf != 0))
-                except AssertionError:
-                    logger.error("No emtpy tile was selected for the debug mode. Increase the number of sampled tiles in debug mode")
-                    exit(1)
+                assert(len(empty_tiles_gdf != 0)), "No empty tiles could be added. Increase the number of tiles sampled in debug mode"
 
             oth_tiles_gdf = oth_tiles_gdf[~oth_tiles_gdf.id.astype(str).isin(empty_tiles_gdf.id.astype(str))].copy()
             oth_tiles_gdf['dataset'] = 'oth'