Skip to content

PellelNitram/xournalpp_htr

Repository files navigation

Xournal++ HTR

python PRs Ruff PyTorch Model Documentation

Developing handwritten text recognition for Xournal++.

Your contributions are greatly appreciated!

Xournal++ HTR in 90 seconds

Installation

For installation instructions, visit this page of the main documentation.

Usage

Visit this page to learn how to use this project as a user and visit this page to learn how to use this project as a developer.

TODO

Contributions

Visit this page of the main documentation to learn how to best contribute to this project.

Thanks! :-)

Cite

If you are using Xournal++ HTR for your research, I'd appreciate if you could cite it. Use:

@software{Lellep_Xournalpp_HTR,
  author = {Lellep, Martin},
  title = {xournalpp_htr},
  url = {https://github.com/PellelNitram/xournalpp_htr},
  license = {GPL-2.0},
}

(Also consider starring the project on GitHub.)

Acknowledgements

I would like to thank Leonard Salewski and Jonathan Prexl for useful discussions, Harald Scheidl for making his repositories about handwritten text recognition public (SimpleHTR, WordDetectorNN and HTRPipeline) and the School of Physics and Astronomy at The University of Edinburgh for providing compute power. Thanks Patrick Kidger for providing great example Github repository templates, see e.g. equinox.

Funding

This project is mostly a solo project and I love to work on it.

However, it is both a large time commitment and requires compute resources for training models.

If you think this project is valuable and want to express your gratitute, then please feel free to buy me a virtual coffee here :-).

Thanks!!