description.schema.yml

title: 'OCR engine model description metadata'
type: 'object'
additionalProperties: false
required:
  - 'author'
  - 'author-email'
  - 'files'
  - 'license'
  - 'modified'
  - 'name'
  - 'summary'
  - 'url'
properties:
  name:
    type: 'string'
    title: 'Name of the model, filename for kraken models'
  supported_engines:
    type: 'array'
    minSize: 1
    items:
  format:
    type: 'string'
    title: 'Format of the model'
    enum:
      - 'clstm'
      - 'hdf5'
      - 'pronn'
      - 'pyrnn'
      - 'pyrnn.gz'
      - 'tesseract-2'
      - 'tesseract-3.01'
      - 'tesseract-3.03'
  summary:
    type: 'string'
    title: 'A summary of the model'
  author:
    type: 'string'
    title: 'Creator of the model'
  author-email:
    type: 'string'
    pattern: '^([^@]+@[^@]+|unknown)$'
    title: 'E-mail address of the creator of the model'
  license:
    type: 'string'
    title: 'License of the model'
    enum: 
      - 'Apache 2.0'
      - 'CC0'
  url:
    type: 'string'
    format: 'uri'
    title: 'Landing page for the model or homepage of the creator'
  modified:
    type: 'string'
    format: 'date-time'
    title: 'Date of last modification'
  files:
    type: 'array'
    title: 'Files that make up this model'
    items: 
      type: 'string'
      title: 'Filename'