Provisioning guide

On startup, MedCAT Trainer can create example projects, datasets, and (optionally) model packs from a YAML config. The provisioner runs after the API is up.

Warning

Provisioning only takes place if there are no preexisting projects/datasets/model packs.

Environment variables

Variable	Required	Description
LOAD_EXAMPLES	Yes (to enable)	Set to true to provision on startup
API_URL	No	Base API URL (e.g. http://localhost:8001/api/). Default: http://localhost:8001/api/.
PROVISIONING_CONFIG_PATH	No	Path to the provisioning YAML file. Default: scripts/provisioning/example_projects.provisioning.yaml.

YAML format

Top-level key is projects, a list of project specs. Each item is either a model-pack project or a remote-model-service project.

Option 1: Model pack (upload a .zip)

projects:
  - modelPack:
      name: "Example Model Pack"
      url: "https://example.com/path/to/model_pack.zip"
    dataset:
      name: "My Dataset"
      url: "https://example.com/dataset.csv"
      description: "Short description of the dataset"
    project:
      name: "Example Project"
      description: "Project description"
      annotationGuidelineLink: "https://example.com/guidelines"

Option 2: Remote MedCAT service (no model pack)

Use a remote MedCAT service API for document processing instead of uploading a model pack. Set useModelService and modelServiceUrl on the project object; do not set modelPack on the spec.

projects:
  - dataset:
      name: "My Dataset"
      url: "https://example.com/dataset.csv"
      description: "Short description"
    project:
      name: "Example Project - Remote"
      description: "Uses remote MedCAT service"
      annotationGuidelineLink: "https://example.com/guidelines"
      useModelService: true
      modelServiceUrl: "http://medcat-service:8000"