Skip to content

A template for creating an OCR model repository with various functions and features, such as metadata creation and presentation.

License

Notifications You must be signed in to change notification settings

UB-Mannheim/ocr-model-repo-template

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

75 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🔑 What does this repo template offer for You?

A template for the creation of an OCR Model Repo(sitory) with the following functions and features:

  • help for the creation of metadata for the OCR Model Repo
  • guidelines for filing and organizing the OCR Model Repo
  • automatic functions that control a github-action-workflow:
    • evaluation and generation of metadata in the formats.
      • JSON (metadata.json)
      • YML (metadata.yml)
    • generation of a GithubPage (ph) for the internet users
    • generation of README

👷 👷‍♀️ How to use the template

Step 1

  • Create a repository for your OCR Model. Click on the Use this Template button.
  • Save your data to the repository. Your data should be stored in the Data folder. See the Organization of folders and files in the Repo 🗀

Step 2

  • Metadata is necessary to ensure that your repository is documented correctly. It is best to use the metadata form to record the metadata.

Step 3

Step 4

  • The README file is also updated during the analysis. This contains [the sections (tags): Title, Description, Metadata, Models, GitHub-Pages.
  • The sections, marked with , are updated automatically.
  • Outside of the sections, marked with , you can customise the README file.

📁 Organization of folders and files in the OCR-Model-Repo

The structure of the repo is the following:

├── LICENSE.md
├── README.md
├── docs
└── data
   └── ocr-engine / software
      └── title or identifier
         ├── model(s)
         └── metadata       

🤖 How to start the automatic functions?

The github-action-workflow is triggered by assigning a version tag (e.g. v1.8.11, V1.8.11, 1.8.11) at push. The version tag consists of a three-part number code. Number code: e.g. 1.8.11 The number code has the following meaning:

  • the first number indicates the version number (1).
  • the second number indicates the feature (8)
  • the third number indicates the fixes, paths... (11)

📓 OCR Model repo metadata

You can find metadata about the OCR Model Repo in the following files.

  • metadata.json
  • metadata.yml
  • CITATION.cff

The content of the metadata files is the same, only the formats vary. You can find the file at:

  • metadata.json 🠂
  • metadata.yml 🠂
  • CITATION.cff 🠂

About

A template for creating an OCR model repository with various functions and features, such as metadata creation and presentation.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published