restructirng md

README.md

@@ -11,5 +11,10 @@ models:
     "Riksarkivet/rtmdet_lines",
     "Riksarkivet/satrn_htr",
   ]
-datasets: []
+datasets:
+  [
+    "Riksarkivet/placeholder_region_segmentation",
+    "Riksarkivet/placeholder_htr",
+    "Riksarkivet/placeholder_htr",
+  ]
 ---

helper/text/help/faq.md

@@ -0,0 +1,10 @@
+## Frequently asked questions
+
+**Q**: <u>How do I sign up for an account?</u>
+**A** : Click on the 'Sign Up' button on the top right corner of our homepage. Fill in the required details, and you'll be set up in no time!
+
+Q: <u>Is my data secure?</u>
+A: Absolutely. We prioritize user data security and have implemented robust encryption methods to ensure your data remains private and protected.
+
+Q: <u>Who can I contact for technical support?</u>
+A: Please reach out to our support team at support@email.com for any technical queries.

helper/text/markdown_reader.py

@@ -0,0 +1,5 @@
+def read_markdown(file_path: str) -> str:
+    with open(file_path, "r") as file:
+        content = file.read()
+
+    return f"""{content}"""

helper/text/{text_howto.py → text_help.py}

@@ -1,3 +1,6 @@
+from helper.text.markdown_reader import read_markdown
+
+
 class TextHowTo:
     htr_tool = """
     ## Getting Started with the HTR Tool
@@ -180,6 +183,24 @@ print(job.result())
 
                         """
 
+    text_faq = read_markdown("helper/text/help/faq.md")
+
+    text_contact = """
+
+"""
+
+    discussion = """
+    ## Get in Touch
+
+    If you have suggestions, questions, or would like to discuss our roadmap further, please don't hesitate to reach out.
+    Press badge below to open a discussion on HuggingFace.
+
+    <p align="center">
+        <a href="https://huggingface.co/spaces/Riksarkivet/htr_demo/discussions">
+            <img src="https://huggingface.co/datasets/huggingface/badges/raw/main/open-a-discussion-xl-dark.svg" alt="Badge 1">
+        </a>
+    </p>"""
+
 
 if __name__ == "__main__":
     pass

helper/text/text_roadmap.py

@@ -24,17 +24,30 @@ class TextRoadmap:
 
     """
 
-    discussion = """
-    ## Get in Touch
+    changelog = """
 
-    If you have suggestions, questions, or would like to discuss our roadmap further, please don't hesitate to reach out.
-    Press badge below to open a discussion on HuggingFace.
+## App Changelog
 
-    <p align="center">
-        <a href="https://huggingface.co/spaces/Riksarkivet/htr_demo/discussions">
-            <img src="https://huggingface.co/datasets/huggingface/badges/raw/main/open-a-discussion-xl-dark.svg" alt="Badge 1">
-        </a>
-    </p>"""
+### [0.0.1] - 2023-10-19
+
+#### Added
+
+- Stepwise feature > Explore results > New Text diff and CER components
+
+#### Fixed
+
+- ..
+
+#### Changed
+
+- Layout in both Fast track and Stepwise to improve the UX
+
+### Removed
+
+- ..
+
+    
+"""
 
     roadmap_image = """  
     <figure>

tabs/about_tab.py

@@ -31,24 +31,9 @@ with gr.Blocks() as about_tab:
             with gr.Row():
                 gr.Markdown(TextRoadmap.text_contribution)
 
-        # with gr.Tab("API & Duplicate for own use"):
-        #     with gr.Row():
-        #         with gr.Column():
-        #             gr.Markdown(TextHowTo.htr_tool_api_text)
-        #             gr.Code(
-        #                 value=TextHowTo.code_for_api,
-        #                 language="python",
-        #                 interactive=False,
-        #                 show_label=False,
-        #             )
-        #         with gr.Column():
-        #             gr.Markdown(TextHowTo.duplicatin_space_htr_text)
-        #             gr.Markdown(TextHowTo.figure_htr_hardware)
-        #             gr.Markdown(TextHowTo.duplicatin_for_privat)
-
         with gr.Tab("Changelog & Roadmap"):
             with gr.Row():
                 with gr.Column():
-                    gr.Markdown(TextRoadmap.roadmap)
+                    gr.Markdown(TextRoadmap.changelog)
                 with gr.Column():
-                    gr.Markdown(TextRoadmap.discussion)
+                    gr.Markdown(TextRoadmap.roadmap)

tabs/help_tab.py

@@ -1,35 +1,55 @@
 import gradio as gr
 
-from helper.text.text_howto import TextHowTo
+from helper.text.text_help import TextHowTo
 
 with gr.Blocks() as help_tab:
-    gr.Markdown("lorem ipsum...")
     with gr.Tabs():
-        with gr.Tab("Discussion & FAQ"):
-            pass
+        with gr.Tab("FAQ & Discussion"):
+            with gr.Row():
+                with gr.Column():
+                    gr.Markdown(TextHowTo.text_faq)
+                with gr.Column():
+                    gr.Markdown(TextHowTo.discussion)
 
         with gr.Tab("Fast track"):
             pass
         with gr.Tab("Stepwise"):
             with gr.Row():
-                with gr.Accordion("Info", open=False) as example_accord:
-                    with gr.Row(equal_height=False):
-                        gr.Markdown(TextHowTo.stepwise_htr_tool)
-                    with gr.Row():
-                        gr.Markdown(TextHowTo.stepwise_htr_tool_tab_intro)
-                    with gr.Row():
-                        with gr.Tabs():
-                            with gr.Tab("1. Region Segmentation"):
-                                gr.Markdown(TextHowTo.stepwise_htr_tool_tab1)
-                            with gr.Tab("2. Line Segmentation"):
-                                gr.Markdown(TextHowTo.stepwise_htr_tool_tab2)
-                            with gr.Tab("3. Transcribe Text"):
-                                gr.Markdown(TextHowTo.stepwise_htr_tool_tab3)
-                            with gr.Tab("4. Explore Results"):
-                                gr.Markdown(TextHowTo.stepwise_htr_tool_tab4)
-                    gr.Markdown(TextHowTo.stepwise_htr_tool_end)
+                with gr.Row(equal_height=False):
+                    gr.Markdown(TextHowTo.stepwise_htr_tool)
+                with gr.Row():
+                    gr.Markdown(TextHowTo.stepwise_htr_tool_tab_intro)
+                with gr.Row():
+                    with gr.Tabs():
+                        with gr.Tab("1. Region Segmentation"):
+                            gr.Markdown(TextHowTo.stepwise_htr_tool_tab1)
+                        with gr.Tab("2. Line Segmentation"):
+                            gr.Markdown(TextHowTo.stepwise_htr_tool_tab2)
+                        with gr.Tab("3. Transcribe Text"):
+                            gr.Markdown(TextHowTo.stepwise_htr_tool_tab3)
+                        with gr.Tab("4. Explore Results"):
+                            gr.Markdown(TextHowTo.stepwise_htr_tool_tab4)
+                gr.Markdown(TextHowTo.stepwise_htr_tool_end)
 
         with gr.Tab("API"):
+            with gr.Row():
+                with gr.Column():
+                    gr.Markdown(TextHowTo.htr_tool_api_text)
+                    gr.Code(
+                        value=TextHowTo.code_for_api,
+                        language="python",
+                        interactive=False,
+                        show_label=False,
+                    )
+                with gr.Column():
+                    gr.Markdown("output")
+
             pass
         with gr.Tab("Duplicating for own use"):
-            pass
+            with gr.Row():
+                with gr.Column():
+                    gr.Markdown(TextHowTo.duplicatin_space_htr_text)
+                    gr.Markdown(TextHowTo.figure_htr_hardware)
+
+                with gr.Column():
+                    gr.Markdown(TextHowTo.duplicatin_for_privat)

tabs/htr_tool.py

@@ -262,5 +262,5 @@ with gr.Blocks() as htr_tool_tab:
     fast_track_output_image.select(
         fast_track.get_text_from_coords, inputs=text_polygon_dict, outputs=selection_text_from_image_viewer
     )
-    gr.Variable()
+
     htr_pipeline_button.click(fn=TrafficDataHandler.store_metric_data, inputs=htr_pipeline_button_var)

tabs/stepwise_htr_tool.py

@@ -6,6 +6,7 @@ import evaluate
 import gradio as gr
 
 from helper.examples.examples import DemoImages
+from helper.utils import TrafficDataHandler
 from src.htr_pipeline.gradio_backend import CustomTrack, SingletonModelLoader
 
 model_loader = SingletonModelLoader()
@@ -68,6 +69,8 @@ with gr.Blocks() as stepwise_htr_tool_tab:
                             elem_id="region_segment_button",
                         )
 
+                        region_segment_button_var = gr.State(value="region_segment_button")
+
                 with gr.Column(scale=2):
                     with gr.Box():
                         with gr.Row():
@@ -373,3 +376,5 @@ with gr.Blocks() as stepwise_htr_tool_tab:
             image_placeholder_lines,
         ],
     )
+
+    region_segment_button.click(fn=TrafficDataHandler.store_metric_data, inputs=region_segment_button_var)