Skip to content

Docs: Add custom fine-tuning tutorial to TrOCR model page #38847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Ashutosh-4485
Copy link

@Ashutosh-4485 Ashutosh-4485 commented Jun 16, 2025

Docs: add community fine‑tuning notebook link to TrOCR page

What does this PR do?

Adds a link to a community tutorial notebook in the TrOCR model docs.

The notebook demonstrates fine-tuning TrOCR on a custom custom dataset and includes multiple training strategies:

  • Train all parameters
  • Train encoder only (freeze decoder)
  • Train decoder only (freeze encoder)
  • Train only the last N layers of both encoder and decoder

Tutorial link: https://github.com/Ashutosh-4485/trocr-custom-fine-tune/blob/66010bcdaf45313b829fa83b3c1ba20002e3c323/FineTune_TrOCR_on_Custom_data.ipynb

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

Docs: add community fine‑tuning notebook link to TrOCR page
Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding a tutorial!

@@ -56,6 +56,7 @@ This model was contributed by [nielsr](https://huggingface.co/nielsr). The origi
on both printed (e.g. the [SROIE dataset](https://paperswithcode.com/dataset/sroie) and handwritten (e.g. the [IAM
Handwriting dataset](https://fki.tic.heia-fr.ch/databases/iam-handwriting-database>) text recognition tasks. For more
information, see the [official models](https://huggingface.co/models?other=trocr>).
- Fine‑tune TrOCR on your **own** OCR dataset (Jupyter notebook) — [link](https://github.com/Ashutosh-4485/trocr-custom-fine-tune.git)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Fine‑tune TrOCR on your **own** OCR dataset (Jupyter notebook) — [link](https://github.com/Ashutosh-4485/trocr-custom-fine-tune.git)
- [Fine‑tune TrOCR on your own OCR dataset](https://github.com/Ashutosh-4485/trocr-custom-fine-tune.git).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants