small changes for text

app.py

@@ -12,12 +12,11 @@ from tabs.htr_tool import htr_tool_tab
 from tabs.stepwise_htr_tool import stepwise_htr_tool_tab
 
 session_uuid = str(uuid.uuid1())
-VERSION = "Demo version 0.0.2"
 
 with gr.Blocks(title="Riksarkivet", theme=theme, css=css) as demo:
     with gr.Row():
         with gr.Column(scale=1):
-            text_ip_output = gr.Markdown(VERSION)
+            text_ip_output = gr.Markdown(TextApp.demo_version)
         with gr.Column(scale=1):
             gr.Markdown(TextApp.title_markdown)
         with gr.Column(scale=1):

helper/text/help/faq.md

@@ -1,10 +1,9 @@
 ## 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!
+WIP
 
-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>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.
+**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/text_app.py

@@ -1,4 +1,6 @@
 class TextApp:
+    demo_version = """Demo version 0.0.1"""
+
     title_markdown = """
 
 

helper/text/text_help.py

@@ -34,13 +34,12 @@ class TextHowTo:
     stepwise_htr_tool = """
 ## Stepwise HTR Tool
 
-The Stepwise HTR Tool is a powerful tool for performing Handwritten Text Recognition (HTR) tasks. The Stepwise version provides you with fine-grained control over each step of the HTR process, allowing for greater customization and troubleshooting capabilities. <br>
-With the Stepwise HTR Tool, you can break down the HTR process into distinct steps: region segmentation, line segmentation, text transcription, and result exploration. This tool offers a range of configuration options to tailor the HTR process to your specific needs. You can adjust settings such as P-threshold and C-threshold to fine-tune the region and line segmentation, and choose from a selection of underlying machine learning models to drive each step of the process. <br>
-The Stepwise HTR Tool also provides a dedicated Explore Results tab, allowing you to thoroughly analyze and interact with the transcriptions. You can sort and identify both bad and good predictions, helping you gain insights and make improvements to the HTR accuracy. Each step is interconnected, and the output of one step serves as the input for the next step, ensuring a seamless and efficient workflow.
-
+Here you can break down the HTR process into distinct steps: Region segmentation, Line segmentation, Text recognition, and Explore results. You can adjust the settings for each part, and choose from a selection of underlying machine learning models to drive each step of the process. Each step is interconnected, and the output of one step serves as the input for the next step, ensuring a seamless and efficient workflow.
 """
     stepwise_htr_tool_tab_intro = """
-    Follow the instructions below provided in each tab to perform the respective step of the HTR process and ensure you work through the tabs sequentially:
+Follow the instructions below:
+
+
 
 """
 
@@ -122,9 +121,9 @@ Alternatively, you can watch the instructional video below, which provides a ste
 </figure> 
 """
     duplicatin_space_htr_text = """
-## Duplicating for Private Use
+## Duplicating for own Use
 
-It's worth noting that while using any public Space as an API is possible, there's a catch. Hugging Face might rate limit you if you send an excessive number of requests in a short period. However, there's a workaround for those who need to make frequent API calls. By duplicating a public Space, you can create your own private Space. This private version allows you to make unlimited requests without any restrictions. So, if you're planning on heavy usage duplicate space:
+It's worth noting that while using any poublic Space as an API is possible, there's a catch. Hugging Face might rate limit you if you send an excessive number of requests in a short period. However, there's a workaround for those who need to make frequent API calls. By duplicating a public Space, you can create your own private Space. This private version allows you to make unlimited requests without any restrictions. So, if you're planning on heavy usage duplicate space:
 
 <br>
 <p align="center">
@@ -155,33 +154,44 @@ job = client.submit(
 
 print(job.result())
 
-# Loaded as API: http://127.0.0.1:7860/ ✔
-# <?xml version="1.0" encoding="UTF-8"?>
-# <PcGts xmlns="http://schema.primaresearch.org/PAGE/gts/pagecontent/2013-07-15" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schema.primaresearch.org/PAGE/gts/pagecontent/2013-07-15 http://schema.primaresearch.org/PAGE/gts/pagecontent/2013-07-15/pagecontent.xsd">
-#     <Metadata>
-#         <Creator>Swedish National Archives</Creator>
-#         <Created>2023-08-21, 13:28:06</Created>
-#     </Metadata>
-#     <Page imageFilename="page_xml.xml" imageWidth="4885" imageHeight="4066">
-#     <TextRegion id="region_0" custom="readingOrder {index:0;}">
-#         <Coords points="1477,265 1467,217 1440,201 1370,211 1248,203 1127,224 1067,224 1003,212 844,247 766,243 747,261 742,280 751,332 766,346 1258,341 1357,332 1439,341 1468,327"/>
-#     <TextLine id="line_region_0_0" custom="readingOrder {index:0;}">
-#                 <Coords points="1458,248 1443,222 1449,200 1412,215 1366,200 1325,207 1302,200 1241,200 1235,206 1205,200 1187,210 1085,222 957,206 795,239 769,273 771,333 783,340 1445,333 1450,324"/>
-#                                 <TextEquiv>
-#             <Unicode>År 1865.</Unicode>
-#         </TextEquiv>
-#                         <PredScore pred_score="0.9482"/>
-#             </TextLine>
-#     </TextRegion>
-#     <TextRegion id="region_1" custom="readingOrder {index:1;}">
-# ......................................
-#     </TextRegion>
-#     </Page>
-# </PcGts>
+"""
+    output_code_for_api_text = """
+### Output from the api
 
-# Output is truncated. View as a scrollable element or open in a text editor. Adjust cell output settings...
+The output from the api is currently in the format of Page XML, which can be imported into transkibus or be viewed in this [viewer](https://huggingface.co/spaces/Riksarkivet/Viewer_demo).
+
+
+"""
+
+    output_code_for_api = """
+
+
+Loaded as API: http://127.0.0.1:7860/ ✔
+<?xml version="1.0" encoding="UTF-8"?>
+<PcGts xmlns="http://schema.primaresearch.org/PAGE/gts/pagecontent/2013-07-15" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schema.primaresearch.org/PAGE/gts/pagecontent/2013-07-15 http://schema.primaresearch.org/PAGE/gts/pagecontent/2013-07-15/pagecontent.xsd">
+    <Metadata>
+        <Creator>Swedish National Archives</Creator>
+        <Created>2023-08-21, 13:28:06</Created>
+    </Metadata>
+    <Page imageFilename="page_xml.xml" imageWidth="4885" imageHeight="4066">
+    <TextRegion id="region_0" custom="readingOrder {index:0;}">
+        <Coords points="1477,265 1467,217 1440,201 1370,211 1248,203 1127,224 1067,224 1003,212 844,247 766,243 747,261 742,280 751,332 766,346 1258,341 1357,332 1439,341 1468,327"/>
+    <TextLine id="line_region_0_0" custom="readingOrder {index:0;}">
+                <Coords points="1458,248 1443,222 1449,200 1412,215 1366,200 1325,207 1302,200 1241,200 1235,206 1205,200 1187,210 1085,222 957,206 795,239 769,273 771,333 783,340 1445,333 1450,324"/>
+                                <TextEquiv>
+            <Unicode>År 1865.</Unicode>
+        </TextEquiv>
+                        <PredScore pred_score="0.9482"/>
+            </TextLine>
+    </TextRegion>
+    <TextRegion id="region_1" custom="readingOrder {index:1;}">
+......................................
+    </TextRegion>
+    </Page>
+</PcGts>
 
-                        """
+# Output is truncated. View as a scrollable element or open in a text editor. Adjust cell output settings...
+ """
 
     text_faq = read_markdown("helper/text/help/faq.md")
 
@@ -190,7 +200,7 @@ print(job.result())
 """
 
     discussion = """
-    ## Get in Touch
+    ## Discussion about the app
 
     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.
@@ -199,7 +209,15 @@ print(job.result())
         <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>"""
+    </p>
+    
+    ## Open discussion
+    DIGG...
+
+    ## Contact us
+    email..
+
+    """
 
 
 if __name__ == "__main__":

helper/text/text_roadmap.py

@@ -26,7 +26,7 @@ class TextRoadmap:
 
     changelog = """
 
-## App Changelog
+## Changelog
 
 ### [0.0.1] - 2023-10-19
 
@@ -36,7 +36,7 @@ class TextRoadmap:
 
 #### Fixed
 
-- ..
+- -
 
 #### Changed
 
@@ -44,7 +44,7 @@ class TextRoadmap:
 
 ### Removed
 
-- ..
+- -
 
     
 """

tabs/about_tab.py

@@ -6,9 +6,6 @@ from helper.text.text_roadmap import TextRoadmap
 with gr.Blocks() as about_tab:
     with gr.Tabs():
         with gr.Tab("HTRFLOW"):
-            gr.Markdown(
-                "update... todo.. here we should talk about the pipline and the app as seperate things... pipline overview perhaps be moved?"
-            )
             with gr.Row():
                 with gr.Column():
                     gr.Markdown(TextAbout.intro_text)
@@ -18,13 +15,13 @@ with gr.Blocks() as about_tab:
                 gr.Markdown(TextAbout.pipeline_overview_text)
             with gr.Row():
                 with gr.Tabs():
-                    with gr.Tab("1. Binarization"):
+                    with gr.Tab("Binarization"):
                         gr.Markdown(TextAbout.binarization)
-                    with gr.Tab("2. Region Segmentation"):
+                    with gr.Tab("Region segmentation"):
                         gr.Markdown(TextAbout.text_region_segment)
-                    with gr.Tab("3. Line Segmentation"):
+                    with gr.Tab("Line segmentation"):
                         gr.Markdown(TextAbout.text_line_segmentation)
-                    with gr.Tab("4. Transcriber"):
+                    with gr.Tab("Text recognition"):
                         gr.Markdown(TextAbout.text_htr)
 
         with gr.Tab("Contributions"):
@@ -34,6 +31,9 @@ with gr.Blocks() as about_tab:
         with gr.Tab("Changelog & Roadmap"):
             with gr.Row():
                 with gr.Column():
-                    gr.Markdown(TextRoadmap.changelog)
+                    with gr.Accordion("Current Changelog", open=True):
+                        gr.Markdown(TextRoadmap.changelog)
+                    with gr.Accordion("Old Changelog", open=False):
+                        pass
                 with gr.Column():
                     gr.Markdown(TextRoadmap.roadmap)

tabs/help_tab.py

@@ -12,23 +12,40 @@ with gr.Blocks() as help_tab:
                     gr.Markdown(TextHowTo.discussion)
 
         with gr.Tab("Fast track"):
+            gr.Markdown("WIP")
             pass
         with gr.Tab("Stepwise"):
+            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"):
+                        with gr.Row():
+                            with gr.Column():
+                                gr.Markdown(TextHowTo.stepwise_htr_tool_tab1)
+                            with gr.Column():
+                                gr.Markdown("image")
+                    with gr.Tab("2. Line Segmentation"):
+                        with gr.Row():
+                            with gr.Column():
+                                gr.Markdown(TextHowTo.stepwise_htr_tool_tab2)
+                            with gr.Column():
+                                gr.Markdown("image")
+                    with gr.Tab("3. Transcribe Text"):
+                        with gr.Row():
+                            with gr.Column():
+                                gr.Markdown(TextHowTo.stepwise_htr_tool_tab3)
+                            with gr.Column():
+                                gr.Markdown("image")
+                    with gr.Tab("4. Explore Results"):
+                        with gr.Row():
+                            with gr.Column():
+                                gr.Markdown(TextHowTo.stepwise_htr_tool_tab4)
+                            with gr.Column():
+                                gr.Markdown("image")
             with gr.Row():
-                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"):
@@ -42,7 +59,14 @@ with gr.Blocks() as help_tab:
                         show_label=False,
                     )
                 with gr.Column():
-                    gr.Markdown("output")
+                    gr.Markdown(TextHowTo.output_code_for_api_text)
+
+                    gr.Code(
+                        value=TextHowTo.output_code_for_api,
+                        language=None,
+                        interactive=False,
+                        show_label=False,
+                    )
 
             pass
         with gr.Tab("Duplicating for own use"):

tabs/htr_tool.py

@@ -46,7 +46,7 @@ with gr.Blocks() as htr_tool_tab:
                 with gr.Tab("Visualize") as tab_image_viewer_selector:
                     with gr.Row():
                         gr.Button(
-                            value="Image Viewer (demo)",
+                            value="Image viewer",
                             variant="secondary",
                             link="https://huggingface.co/spaces/Riksarkivet/Viewer_demo",
                             interactive=True,