added comments

src/control.py

@@ -1,9 +1,9 @@
 import streamlit as st
 
-# TODO: rename everything
+# TODO: rename and refactor everything
 
 
-def select_int_interval(param_name, limits_list, defaults, **kwargs):
+def select_int_interval(param_name: str, limits_list: list, defaults, **kwargs):
     st.sidebar.subheader(param_name)
     min_max_interval = st.sidebar.slider(
         "", limits_list[0], limits_list[1], defaults, key=hash(param_name)

src/utils.py

@@ -7,6 +7,10 @@ import streamlit as st
 
 @st.cache
 def get_images_list(path_to_folder: str) -> list:
+    """Return the list of images from folder
+    Args:
+        path_to_folder (str): absolute or relative path to the folder with images
+    """
     image_names_list = [
         x for x in os.listdir(path_to_folder) if x[-3:] in ["jpg", "peg", "png"]
     ]
@@ -17,6 +21,12 @@ def get_images_list(path_to_folder: str) -> list:
 def load_image(
     image_name: str, path_to_folder: str = "../images", bgr2rgb: bool = True
 ):
+    """Load the image
+    Args:
+        image_name (str): name of the image
+        path_to_folder (str): path to the folder with image
+        bgr2rgb (bool): converts BGR image to RGB if True
+    """
     path_to_image = os.path.join(path_to_folder, image_name)
     image = cv2.imread(path_to_image)
     if bgr2rgb:
@@ -28,6 +38,11 @@ def load_image(
 def load_augmentations_config(
     placeholder_params: dict, path_to_config: str = "configs/augmentations.json"
 ) -> dict:
+    """Load the json config with params of all transforms
+    Args:
+        placeholder_params (dict): dict with values of placeholders
+        path_to_config (str): path to the json config file
+    """
     with open(path_to_config, "r") as config_file:
         augmentations = json.load(config_file)
     for name, params in augmentations.items():
@@ -35,7 +50,12 @@ def load_augmentations_config(
     return augmentations
 
 
-def fill_placeholders(params, placeholder_params):
+def fill_placeholders(params: dict, placeholder_params: dict) -> dict:
+    """Fill the placeholder values in the config file
+    Args:
+        params (dict): original params dict with placeholders
+        placeholder_params (dict): dict with values of placeholders
+    """
     # TODO: refactor
     if "placeholder" in params:
         placeholder_dict = params["placeholder"]
@@ -57,6 +77,10 @@ def fill_placeholders(params, placeholder_params):
 
 
 def get_params_string(param_values: dict) -> str:
+    """Generate the string from the dict with parameters
+    Args:
+        param_values (dict): dict of "param_name" -> "param_value"
+    """
     params_string = ", ".join(
         [k + "=" + str(param_values[k]) for k in param_values.keys()]
     )