fix: add function _parse_bitdepth to utils.loading.__init__.py

update docs for export_metadata

Author: lukasbehammer

src/viqa/utils/__init__.py

@@ -36,6 +36,7 @@
     "_rgb_to_yuv",
     "_get_binary",
     "_resize_image",
+    "_parse_bitdepth",
     "_check_border_too_close",
     "_check_chromatic",
     "_extract_blocks",
@@ -69,6 +70,7 @@
     _check_imgs,
     _load_binary,
     _load_data_from_disk,
+    _parse_bitdepth,
     _resize_image,
     crop_image,
     load_data,

src/viqa/utils/export.py

@@ -119,10 +119,14 @@ def export_metadata(metrics, metrics_parameters, file_path, file_name="metadata.
 
     Notes
     -----
+        The timestamp, added to the txt file, is the current time when the report is
+        generated.
+
         .. attention::
 
             The txt file will be overwritten if it already exists.
     """
+    # TODO: Change this to use the class attribute parameter
     if os.path.splitext(file_name)[1] != ".txt":
         raise ValueError(f"The file name {file_name} must have the extension '.txt'.")
     path = os.path.join(file_path, file_name)