added new dataset

.gitignore

@@ -21,3 +21,5 @@ src/htr_pipeline.egg-info/
 page_xml.xml
 page_txt.txt
 transcribed_text.txt
+helper/examples/.cache_images/
+helper/examples/images/*.jpg

app.py

@@ -1,17 +1,17 @@
+import os
+import shutil
+
 import gradio as gr
 
-from helper.examples.examples import ExamplesImages
+from helper.examples.examples import DemoImages
 from helper.gradio_config import css, js, theme
-from helper.text.text_about import TextAbout
-from helper.text.text_app import TextApp
-from helper.text.text_howto import TextHowTo
-from helper.text.text_riksarkivet import TextRiksarkivet
-from helper.text.text_roadmap import TextRoadmap
+from helper.text import TextAbout, TextApp, TextHowTo, TextRiksarkivet, TextRoadmap
 from src.htr_pipeline.gradio_backend import CustomTrack, FastTrack, SingletonModelLoader
 
 model_loader = SingletonModelLoader()
 fast_track = FastTrack(model_loader)
 custom_track = CustomTrack(model_loader)
+images_for_demo = DemoImages()
 
 with gr.Blocks(title="HTR Riksarkivet", theme=theme, css=css) as demo:
     gr.Markdown(" ")
@@ -36,15 +36,17 @@ with gr.Blocks(title="HTR Riksarkivet", theme=theme, css=css) as demo:
                         #     visible=True,
                         # ).style(full_width=True)
                         radio_file_input = gr.Radio(
-                            value="Text file", choices=["Text file", "Page XML"], label="What kind file output?"
+                            value="Text file", choices=["Text file ", "Page XML file "], label="What kind file output?"
                         )
+                    with gr.Row():
+                        htr_clear_button = gr.Button("", variant="Secondary")
 
                         htr_pipeline_button = gr.Button(
                             "Run HTR",
                             variant="primary",
                             visible=True,
                             elem_id="run_pipeline_button",
-                        ).style(full_width=False)
+                        ).style(full_width=True)
 
                     with gr.Group():
                         with gr.Row():
@@ -54,8 +56,8 @@ with gr.Blocks(title="HTR Riksarkivet", theme=theme, css=css) as demo:
                                 fast_name_files_placeholder = gr.Markdown(visible=False)
 
                                 gr.Examples(
-                                    examples=ExamplesImages.example_images_with_info,
-                                    inputs=[fast_track_input_region_image, fast_name_files_placeholder],
+                                    examples=images_for_demo.examples_list,
+                                    inputs=[fast_name_files_placeholder, fast_track_input_region_image],
                                     label="Example images",
                                     examples_per_page=3,
                                 )
@@ -82,6 +84,7 @@ with gr.Blocks(title="HTR Riksarkivet", theme=theme, css=css) as demo:
                 with gr.Tab("1. Region Segmentation"):
                     with gr.Row():
                         with gr.Column(scale=2):
+                            vis_data_folder_placeholder = gr.Markdown(visible=False)
                             name_files_placeholder = gr.Markdown(visible=False)
 
                             with gr.Row():
@@ -132,8 +135,8 @@ with gr.Blocks(title="HTR Riksarkivet", theme=theme, css=css) as demo:
                             with gr.Row():
                                 with gr.Accordion("Example images to use:", open=False) as example_accord:
                                     gr.Examples(
-                                        examples=ExamplesImages.example_images_with_info,
-                                        inputs=[input_region_image, name_files_placeholder],
+                                        examples=images_for_demo.examples_list,
+                                        inputs=[name_files_placeholder, input_region_image],
                                         label="Example images",
                                         examples_per_page=2,
                                     )
@@ -161,7 +164,7 @@ with gr.Blocks(title="HTR Riksarkivet", theme=theme, css=css) as demo:
                                     columns=[2],
                                     rows=[2],
                                     # object_fit="contain",
-                                    height=300,
+                                    height=400,
                                     preview=True,
                                     container=False,
                                 )
@@ -474,8 +477,14 @@ with gr.Blocks(title="HTR Riksarkivet", theme=theme, css=css) as demo:
         outputs=[txt_file_downlod, txt_file_downlod],
     )
 
+    # def remove_temp_vis():
+    #     if os.path.exists("./vis_data"):
+    #         os.remove("././vis_data")
+    #     return None
+
     clear_button.click(
         lambda: (
+            (shutil.rmtree("./vis_data") if os.path.exists("./vis_data") else None, None)[1],
             None,
             None,
             None,
@@ -494,6 +503,7 @@ with gr.Blocks(title="HTR Riksarkivet", theme=theme, css=css) as demo:
         ),
         inputs=[],
         outputs=[
+            vis_data_folder_placeholder,
             input_region_image,
             regions_cropped_gallery,
             input_region_from_gallery,
@@ -520,3 +530,5 @@ demo.queue(concurrency_count=5, max_size=20)
 
 if __name__ == "__main__":
     demo.launch(server_name="0.0.0.0", server_port=7860, show_api=False, show_error=True)
+if __name__ == "__main__":
+    demo.launch(server_name="0.0.0.0", server_port=7860, show_api=False, show_error=True)

helper/examples/create_examples.py

@@ -0,0 +1,61 @@
+import datasets
+
+_CITATION = """\
+@InProceedings{huggingface:dataset,
+title = {Small htr examples images},
+author={Gabriel Borg},
+year={2023}
+}
+"""
+
+_DESCRIPTION = """\
+Demo dataset for the htr demo.
+"""
+_HOMEPAGE = "https://huggingface.co/datasets/Riksarkivet/test_images_demo"
+
+_LICENSE = ""
+
+_REPO = "https://huggingface.co/datasets/Riksarkivet/test_images_demo"
+
+
+class ExampleImages(datasets.GeneratorBasedBuilder):
+    """Small sample of image-text pairs"""
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "text": datasets.Value("string"),
+                    "image": datasets.Image(),
+                }
+            ),
+            supervised_keys=None,
+            homepage=_HOMEPAGE,
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        images_archive = dl_manager.download(f"{_REPO}/resolve/main/images.tar.gz")
+        metadata_path = dl_manager.download(f"{_REPO}/resolve/main/images.txt")
+        image_iters = dl_manager.iter_archive(images_archive)
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN, gen_kwargs={"images": image_iters, "metadata_path": metadata_path}
+            ),
+        ]
+
+    def _generate_examples(self, images, metadata_path):
+        """Generate images and text."""
+        with open(metadata_path, encoding="utf-8") as f:
+            metadata_list = f.read().split("\n")
+        for idx, (img_obj, meta_txt) in enumerate(zip(images, metadata_list)):
+            filepath, image = img_obj
+            yield idx, {
+                "image": {"path": filepath, "bytes": image.read()},
+                "text": meta_txt,
+            }
+
+
+if __name__ == "__main__":
+    pass

helper/examples/examples.py

@@ -1,20 +1,38 @@
-class ExamplesImages:
-    image_path = "./helper/examples/images"
-    example_images_with_info = [
-        [f"{image_path}/1664-Handelskollegiet_A1_0014full.jpg", "1664 HandelsKollegiet"],
-        [
-            f"{image_path}/1735-Södra_förstadens_kämnärsrätt_00042-scan_2020-10-13_14-03-37.jpg",
-            "1735 Södra förstadens kämnärsrätt",
-        ],
-        [f"{image_path}/1777-Hall-_och_Manufakturrätten_HallMan_Sida_03.jpg", "1777 Hall och Manufakturrätten"],
-        [f"{image_path}/1840-1890_H0000304_00034.jpg", "1840-1890 --"],
-        [f"{image_path}/1861_R0000277_00153.jpg", "1861 --"],
-        [f"{image_path}/1664-Handelskollegiet_A1_0014full.jpg", "1664 HandelsKollegiet"],
-        [
-            f"{image_path}/1735-Södra_förstadens_kämnärsrätt_00042-scan_2020-10-13_14-03-37.jpg",
-            "1735 Södra förstadens kämnärsrätt",
-        ],
-        [f"{image_path}/1777-Hall-_och_Manufakturrätten_HallMan_Sida_03.jpg", "1777 Hall och Manufakturrätten"],
-        [f"{image_path}/1840-1890_H0000304_00034.jpg", "1840-1890 --"],
-        [f"{image_path}/1861_R0000277_00153.jpg", "1861 --"],
-    ]
+import io
+
+import datasets
+from PIL import Image
+
+
+class DemoImages:
+    def __init__(self, url="Riksarkivet/test_images_demo", cache_dir="./helper/examples/.cache_images") -> None:
+        self.images_datasets = datasets.load_dataset(url, cache_dir=cache_dir)
+        self.example_df = self.images_datasets["train"].to_pandas()
+        self.examples_list = self.convert_bytes_to_images()
+
+    def convert_bytes_to_images(self):
+        examples_list = []
+        # For each row in the dataframe
+        for index, row in self.example_df.iterrows():
+            image_bytes = row["image"]["bytes"]
+            image = Image.open(io.BytesIO(image_bytes))
+
+            # Set the path to save the image
+            path_to_image = f"./helper/examples/images/image_{index}.jpg"
+
+            # Save the image
+            image.save(path_to_image)
+
+            # Get the description
+            description = row["text"]
+
+            # Append to the examples list
+            examples_list.append([description, path_to_image])
+
+        return examples_list
+
+
+if __name__ == "__main__":
+    test = DemoImages(cache_dir=".cache_images")
+
+    print(test.examples_list)

helper/text/__init__.py

@@ -0,0 +1,8 @@
+from helper.text.text_about import TextAbout
+from helper.text.text_app import TextApp
+from helper.text.text_howto import TextHowTo
+from helper.text.text_riksarkivet import TextRiksarkivet
+from helper.text.text_roadmap import TextRoadmap
+
+if __name__ == "__main__":
+    pass

helper/text/text_about.py

@@ -70,3 +70,7 @@ class TextAbout:
     Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 
     """
+
+
+if __name__ == "__main__":
+    pass

helper/text/text_app.py

@@ -6,3 +6,7 @@ class TextApp:
     <h1><center> Handwritten Text Recognition Tool </center></h1>
 
     <h3><center> Swedish National Archives - Riksarkivet </center></h3>"""
+
+
+if __name__ == "__main__":
+    pass

helper/text/text_howto.py

@@ -92,3 +92,7 @@ To explore the HTR results, follow these steps:
         ##  
         Alternatively, you can watch the instructional video below, which provides a step-by-step walkthrough of the HTR Tool and some additional features.
     """
+
+
+if __name__ == "__main__":
+    pass

helper/text/text_riksarkivet.py

@@ -8,3 +8,7 @@ class TextRiksarkivet:
     ## Contact us
     Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 """
+
+
+if __name__ == "__main__":
+    pass

helper/text/text_roadmap.py

@@ -15,3 +15,7 @@ class TextRoadmap:
     
     Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 """
+
+
+if __name__ == "__main__":
+    pass

requirements.txt

@@ -8,6 +8,7 @@ opencv-python-headless
 jinja2
 transformers
 huggingface_hub
+datasets
 requests
 # scipy
 # sklearn

src/htr_pipeline/models.py

@@ -57,3 +57,7 @@ class HtrModels:
         }
 
         return config_path
+
+
+if __name__ == "__main__":
+    pass

src/htr_pipeline/utils/filter_segmask.py

@@ -124,4 +124,7 @@ class FilterSegMask:
 
         new_filtered_result.pred_instances = new_pred_instances
         return new_filtered_result
-        return new_filtered_result
+
+
+if __name__ == "__main__":
+    pass

src/htr_pipeline/utils/helper.py

@@ -90,10 +90,3 @@ if __name__ == "__main__":
         kwargs={"spam": "eggs"},
     )
     print(retval)
-
-    # Example of using the decorator
-    retval = another_long_running_function()
-    print(retval)
-    retval = another_long_running_function()
-    print(retval)
-    print(retval)

src/htr_pipeline/utils/order_of_object.py

@@ -86,3 +86,7 @@ class OrderObject:
 
         # Return the ordered regions
         return df["region_id"].tolist()
+
+
+if __name__ == "__main__":
+    pass

src/htr_pipeline/utils/parser_xml.py

@@ -74,3 +74,7 @@ class XmlParser:
                     text = textline.find(f"{self.namespace}TextEquiv").find(f"{self.namespace}Unicode").text
                     f.write(text + "\n")
                 f.write("\n")
+
+
+if __name__ == "__main__":
+    pass

src/htr_pipeline/utils/preprocess_img.py

@@ -17,3 +17,7 @@ class Preprocess:
         img_gradio = cv2.cvtColor(threshed, cv2.COLOR_BGR2RGB)
 
         return img_gradio
+
+
+if __name__ == "__main__":
+    pass

src/htr_pipeline/utils/process_segmask.py

@@ -85,3 +85,7 @@ class SegMaskHelper:
         translated_line_polygons = [[[a + box[0], b + box[1]] for [a, b] in poly] for poly in line_polygons]
 
         return translated_line_polygons
+
+
+if __name__ == "__main__":
+    pass

src/htr_pipeline/utils/process_xml.py

@@ -148,3 +148,7 @@ class XMLHelper:
                 text_lines.append(line_data)
 
         return text_lines, htr_scores
+
+
+if __name__ == "__main__":
+    pass