add usage

app.py

@@ -3,7 +3,7 @@ import sahi.utils.mmdet
 import sahi.model
 from PIL import Image
 import random
-from utils import image_compare
+from utils import image_comparison
 from utils import sahi_mmdet_inference
 
 MMDET_YOLACT_MODEL_URL = "https://download.openmmlab.com/mmdetection/v2.0/yolact/yolact_r50_1x8_coco/yolact_r50_1x8_coco_20200908-f38d58df.pth"
@@ -121,7 +121,7 @@ st.markdown(
     <p style='text-align: center'>
     <a href='https://github.com/obss/sahi' target='_blank'>SAHI Github</a> | <a href='https://github.com/open-mmlab/mmdetection/tree/master/configs/yolox' target='_blank'>YOLOX Github</a> | <a href='https://huggingface.co/spaces/fcakyon/sahi-yolov5' target='_blank'>SAHI+YOLOv5 Demo</a>
     <br />
-    Follow me for more! <a href='https://twitter.com/fcakyon' target='_blank'>twitter</a> | <a href='https://www.linkedin.com/in/fcakyon/' target='_blank'>linkedin</a> | <a href='https://fcakyon.medium.com/' target='_blank'>medium</a>
+    Follow me for more! <a href='https://twitter.com/fcakyon' target='_blank'> <img src="https://img.icons8.com/color/48/000000/twitter--v1.png" height="30"></a><a href='https://www.linkedin.com/in/fcakyon/' target='_blank'><img src="https://img.icons8.com/fluency/48/000000/linkedin.png" height="30"></a> <a href='https://fcakyon.medium.com/' target='_blank'><img src="https://img.icons8.com/ios-filled/48/000000/medium-monogram.png" height="27"></a>
     </p>
     """,
     unsafe_allow_html=True,
@@ -129,6 +129,24 @@ st.markdown(
 
 st.write("##")
 
+with st.expander("Usage"):
+    st.markdown(
+        """
+        <p>
+        1. Upload or select the input image 🖼️
+        <br />
+        2. (Optional) Set SAHI parameters ✔️
+        <br />
+        3. Press to "🚀 Perform Prediction"
+        <br />
+        4. Enjoy sliding image comparison 🔥
+        </p>
+        """,
+        unsafe_allow_html=True,
+    )
+
+st.write("##")
+
 col1, col2, col3 = st.columns([6, 1, 6])
 with col1:
     st.markdown(f"##### Set input image:")
@@ -181,9 +199,9 @@ with col3:
     )
     postprocess_class_agnostic = st.checkbox("postprocess_class_agnostic", value=True)
 
-col1, col2, col3 = st.columns([6, 1, 6])
+col1, col2, col3 = st.columns([4, 3, 4])
 with col2:
-    submit = st.button("Submit")
+    submit = st.button("🚀 Perform Prediction")
 
 if submit:
     # perform prediction
@@ -219,7 +237,7 @@ if submit:
     st.session_state["output_2"] = output_2
 
 st.markdown(f"##### YOLOX Standard vs SAHI Prediction:")
-static_component = image_compare(
+static_component = image_comparison(
     img1=st.session_state["output_1"],
     img2=st.session_state["output_2"],
     label1="YOLOX",

utils.py

@@ -86,7 +86,7 @@ def pillow_local_file_to_base64(image: Image.Image):
     return base64_src
 
 
-def image_compare(
+def image_comparison(
     img1: str,
     img2: str,
     label1: str = "1",