Welcome to MedCATtrainer’s documentation!

Contents:

• Medical oncept Annotation Tool Trainer
  • What you can do with MedCATtrainer
  • Typical workflow
  • Documentation map
• Installation
  • Prerequisites
  • Quick start (prebuilt images)
  • Build from source (development)
  • Legacy MedCAT v0.x support
  • Environment configuration
  • OIDC (Keycloak) authentication (optional)
  • PostgreSQL support (optional)
  • Troubleshooting
• Administrator Setup
  • 1) Configure bootstrap admin credentials
  • 2) Sign in and create operational admin users
  • 3) Create annotator users
  • 4) Remove or rotate bootstrap credentials
  • 5) If using OIDC
• Annotation Project Creation and Management
  • Create a project (Project Admin UI)
  • Dataset format
  • Project list operations
  • Concept lookup index (Solr import)
  • Clone, reset, and delete
  • Downloading annotations
  • Saving and downloading model artifacts
• Annotation Project Groups
  • When to use Project Groups
  • Creating a Project Group
  • Updating a group
  • Using groups in the UI
  • Best practices
• Demo / Try Model
  • What it is for
  • Workflow
  • Output panels
• Annotation Interface
  • 1) Document list
  • 2) Clinical text
  • 3) Task bar and submission
  • 4) Header actions
  • 5) Right sidebar (concept details)
  • Meta annotations and relations
  • Keyboard shortcuts
• Meta Annotations
  • Configure meta tasks
  • Model-pack predictions vs manual labels
  • Annotator behavior
  • Reporting
• Advanced Usage
  • Notebook examples
  • REST API basics
  • Project Admin API endpoints
  • Metrics APIs
  • Concept exploration and filter export
  • Remote model service projects
  • Python client
• Maintenance
  • Upgrade workflow
  • Operational checks
  • Backup and restore (SQLite deployments)
  • Release compatibility
• MedCATtrainer Python Client
  • Install
  • Authenticate
  • Minimal example
  • Common methods
  • Notes
• API Reference
  • api

Indices and tables

• Index

• Module Index

• Search Page