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 |
| PII detection & de-identification | extract_pii, deidentify, smart entity merging, HIPAA Safe Harbor compliance. | openmed/core/pii.py, openmed/core/pii_entity_merger.py, PII Detection & Smart Merging |
| 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 |
| Configuration Profiles | Built-in profiles (dev, prod, test, fast) + custom profiles. | openmed/core/config.py, Configuration Profiles |
| Batch Processing | Multi-text/file processing with progress and aggregation. | openmed/processing/batch.py, Batch Processing |
| Performance Profiling | Timing utilities, metrics, and profiling decorators. | openmed/utils/profiling.py, Performance Profiling |
| CLI | openmed console (analyze, batch, tui, models, config). | openmed/cli/main.py, CLI & Automation |
| TUI | Interactive terminal interface for visual NER analysis. | openmed/tui/app.py, TUI - Interactive Terminal |
| 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¶
- Quick Start — install + first inference.
- Analyze Text Helper — single-call orchestration.
- PII Detection & Smart Merging — de-identification (v0.5.0).
- Batch Processing — multi-text processing.
- ModelLoader & Pipelines — lower-level control.
- Model Registry — pick the right checkpoint.
- Configuration Profiles — dev/prod/test profiles.
- Advanced NER & Output Formatting — polish predictions.
- Zero-shot Toolkit — GLiNER workflows.
- Performance Profiling — timing and metrics.
- TUI - Interactive Terminal — visual analysis workbench.
- CLI & Automation and Examples — day-to-day tools.
- Testing & QA + Contributing — team processes.