Skip to content

Quickstart¶

Running HTRflow¶

Once HTRflow is installed, run it with: 

htrflow pipeline <path/to/pipeline.yaml> <path/to/image>
The pipeline sub-command tells HTRflow to apply the pipeline defined in pipeline.yaml on image.jpg. To get started, try the example pipeline in the next section.

An example pipeline¶

Here is an example of an HTRflow pipeline:

pipeline.yaml
steps:
- step: Segmentation
  settings:
    model: yolo
    model_settings:
      model: Riksarkivet/yolov9-lines-within-regions-1
- step: TextRecognition
  settings:
    model: TrOCR
    model_settings:
      model: Riksarkivet/trocr-base-handwritten-hist-swe-2
- step: OrderLines
- step: Export
  settings:
    format: txt
    dest: outputs
This pipeline consists of four steps. The Segmentation step segments the image into lines. Those lines are transcribed by the TextRecognition step and then ordered by reading order by OrderLines. The Export step exports the result as a text file to a directory called outputs.

This pipeline works well for single-column running text such as letters, notes and single pages. Here are some examples to try:

Grayscale scan of an 18th century handwritten note
A moving certificate (sv: "flyttattest") from the 1700s. Source.

Grayscale scan of an 18th century handwritten note
A moving certificate (sv: "flyttattest") from the 1700s. Source.

Scan of a late 19th century handwritten letter
A letter dated 1882. Source.

To run the demo pipeline on your selected image, paste the pipeline content into an empty text file and save it as pipeline.yaml. Assuming the input image is called image.jpg, run HTRflow with: 

htrflow pipeline pipeline.yaml image.jpg
The first run may take some time because the two models need to be downloaded. The outputs are written as text files to a new directory called outputs. Here are the expected results:

image.txt
MÀstaren med det lofliga hammarsmeds hÀmbetet bör
römliga Sven Svensson Hjerpe, som med sin hustru rör
bÀra och dygdesanna Lisa Jansdotter bortflyttrande
till Lungsundt Sochn; bekoma hÀrifrÄn följande
bewis, at mannen Àr född 1746, hustrun 1754.
begge i sina Christandoms stycken grundrade och i
sin lofnad förelgifwande. warit till hittwarden
sin 25/4 och wid Förhören pÄ behörig tid.
Carlskoja fyld 21 Sept: 1773. Bengt Forsman
adj: Past:
Sundberg
image.txt
Beskedeliga mannen Jöns HÄkansson
Född 1730, som med dess hustru Åhreborn till
Margreta Andersdotter född 1736 flygge wÀl
Liungsunds församling, kunna i Àgge wÀl
LÀfft i och utan bok, och förstÄ sin Christendom
Förswarligen, hafwa under sitt wistelig af
hÀr i Församlingen fördt en Christa gÄng
larbar wandel, Commarerade sista gÄng
d. 21. nÀstl. dotren Maria Àr född. 1760.
Det. Sigrid 1767. Son Anders 1768. Attr
Philipstad d. 25. Martii 1773.
And: Levin
Malborj
Comminist loci.
image.txt
Monmouth den 29 1882.
.
Platskade Syster emot SvÄger
HÄ godt Àr min önskan
Jag fÄr Äterigen göra försöket
att sÀnda eder bref, jag har
förut skrifvitt men ej erhallett
nÄgott wÄr frÄn eder var. varför
jag tager det för troligt att
brefven icke har gÄtt fram.
jag har erinu den stora gÄfvan
att hafva en god helsa intill
skrifvande dag, och önskligt
voro att dessa rader trefar
eder vid samma goda gofva.
och jag fÄr önska eder lycka
pÄ det nya Äratt samt god
fortsÀttning pÄ detsamma.

🎉 You have successfully created your first HTRflow pipeline!

Next steps¶