Skip to content

Feature Map & Capabilities

This page inventories every surfaced capability in OpenMed so you can see how the docs map back to the codebase. Use it as the starting point when you are unsure which page (or module) to visit.

Model lifecycle

Area What it covers Where to look
Model registry Curated metadata (ModelInfo, categories, suggestions) for every OpenMed Hugging Face release. openmed/core/model_registry.py, Model Registry
Discovery & loading Hugging Face discovery, optional auth, caching, tokenizers, pipeline helpers. openmed/core/models.py, ModelLoader & Pipelines
One-call inference analyze_text, validation, pySBD segmentation, output formatting for dict/JSON/HTML/CSV. openmed/__init__.py:analyze_text, Analyze Text Helper
Zero-shot toolkit GLiNER-powered indexing, label maps, adapters, smoke scripts. openmed/zero_shot/**, Zero-shot Toolkit

Processing & outputs

Area What it covers Where to look
Advanced NER filtering Entity spanning, score filtering, punct stripping, BIO-aware grouping. openmed/processing/advanced_ner.py, Advanced NER & Output Formatting
Formatting utilities PredictionResult, copy-ready dict/JSON/HTML/CSV outputs, metadata injection. openmed/processing/outputs.py, Advanced NER & Output Formatting
Text utilities Sentence detection, tokenization helpers, text cleaning. openmed/processing/, ModelLoader & Pipelines

Tooling & ops

Area What it covers Where to look
Configuration YAML/ENV + per-run overrides via OpenMedConfig; CLI config store. openmed/core/config.py, Configuration & Validation
CLI openmed console (analyze, models list/info, config show/set). openmed/cli/main.py, CLI & Automation
Testing tests/run-tests.sh, unit/integration markers, smoke runners. tests/, Testing & QA
Examples Notebooks, CLI/analysis snippets, examples/. examples/, Examples & Copy/Paste Recipes
Automation Make targets, GitHub Actions (CI, publish, docs). Makefile, .github/workflows/*.yml, Contributing & Releases

Suggested reading order

  1. Quick Start — install + first inference.
  2. Analyze Text Helper — single-call orchestration.
  3. ModelLoader & Pipelines — lower-level control.
  4. Model Registry — pick the right checkpoint.
  5. Advanced NER & Output Formatting — polish predictions.
  6. Zero-shot Toolkit — GLiNER workflows.
  7. CLI & Automation and Examples — day-to-day tools.
  8. Testing & QA + Contributing — team processes.