त्वरित शुरुआत¶

यह गाइड आपको कुछ ही मिनटों में खाली वर्कस्टेशन से दस्तावेज़ के परिणाम चलाने और कॉपी करने तक ले जाता है। यह डिपेंडेंसी प्रबंधन के लिए uv का उपयोग करता है, लेकिन कोई भी Python 3.11+ वातावरण काम करेगा।

यदि आप रुक-रुककर मिलने वाली connectivity, offline clinics, OpenMRS या DHIS2 के साथ काम कर रहे हैं, तो low-bandwidth model setup, local-only inference, privacy-profile guidance और FHIR integration recipes के लिए African developer onboarding guide का उपयोग करें।

1. वातावरण तैयार करें¶

macOS/LinuxWindows PowerShell

curl -LsSf https://astral.sh/uv/install.sh | sh  # uv इंस्टॉल करें (पहले से हो तो छोड़ें)
uv venv --python 3.11                           # समर्पित वर्चुअल वातावरण बनाएँ
source .venv/bin/activate                       # या सीधे `uv python` का उपयोग करें

# Hugging Face extras और दस्तावेज़ टूलिंग के साथ OpenMed इंस्टॉल करें
uv pip install ".[hf]"

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
uv venv --python 3.11
.venv\Scripts\Activate.ps1

# Hugging Face extras और दस्तावेज़ टूलिंग के साथ OpenMed इंस्टॉल करें
uv pip install ".[hf]"

zero-shot GLiNER स्टैक या डेवलपमेंट टूल चाहिए? आवश्यकतानुसार extras जोड़ें:

uv pip install ".[hf,gliner]"      # GLiNER और transformers जोड़ें
uv pip install ".[dev]"            # pytest, कवरेज और linting

स्कैन की गई इमेज और दस्तावेज़ OCR के लिए, मल्टीमॉडल extra तथा सिस्टम Tesseract बाइनरी इंस्टॉल करें:

uv pip install ".[multimodal]"
brew install tesseract             # macOS
sudo apt-get install tesseract-ocr # Debian/Ubuntu

PaddleOCR एक अधिक भारी, वैकल्पिक OCR बैकएंड के रूप में उपलब्ध है:

uv pip install ".[ocr-paddle]"

CDA/C-CDA XML डी-आइडेंटिफिकेशन मुख्य इंस्टॉलेशन में उपलब्ध है। यह संरचित हेडर PHI को रिडैक्ट करता है, CDA अनुभागों के वर्णनात्मक टेक्स्ट की जाँच करता है, XML को पार्स करने योग्य रखता है और केवल उन्हीं .xml फ़ाइलों को संसाधित करता है जो CDA दस्तावेज़ जैसी दिखती हैं:

from openmed.interop.cda import redact_cda

redacted_xml = redact_cda("synthetic_ccda.xml", date_shift_days=30)

Apple Silicon Mac पर आप नए MLX पथ से सीधे शुरू कर सकते हैं:

uv pip install ".[mlx]"            # Python MLX रनटाइम तथा tokenizer/artifact डिपेंडेंसी
uv run python -c "from openmed.core.backends import get_backend; print(type(get_backend()).__name__)"

यदि एक ही मशीन पर पूरी लॉन्च सतह चाहिए, तो extras को मिलाएँ:

uv pip install ".[hf,mlx,docs]"

2. `analyze_text` चलाएँ¶

from openmed import analyze_text

text = "Metastatic breast cancer treated with paclitaxel and trastuzumab."

resp = analyze_text(text, model_name="disease_detection_superclinical")
print(resp.entities[0])

# एम्बेड करने योग्य HTML चाहिए तो "html" आउटपुट फ़ॉर्मैट चुनें
html = analyze_text(text, model_name="disease_detection_superclinical", output_format="html")
print(html)  # डैशबोर्ड या दस्तावेज़ के लिए तैयार

त्वरित स्क्रिप्ट एंट्रीपॉइंट पसंद है? एक-फ़ाइल smoke script चलाएँ:

uv run python examples/pii_model_comparison.py

3. PII का डी-आइडेंटिफिकेशन करें¶

from openmed import deidentify

result = deidentify("Patient John Doe, DOB 01/15/1970", method="mask")
print(result.deidentified_text)
# Patient [first_name] [last_name], DOB [date]

deidentify() पाँच विधियों (mask, remove, replace, hash, shift_dates) का समर्थन करता है। प्रत्येक का चलने योग्य उदाहरण और reidentify() से परिणाम वापस पाने का तरीका अनामिकरण त्वरित शुरुआत में देखें।

4. Offline उपयोग के लिए model को विश्वसनीय तरीके से pull करें¶

Offline काम शुरू करने से पहले Hugging Face cache को warm करने के लिए model pull command चलाएँ। बाधित transfer के बाद download दोबारा शुरू होता है, अस्थायी network failures पर retry करता है और Hub metadata के विरुद्ध हर file को verify करता है:

openmed models pull disease_detection_superclinical

Metered या unstable connection पर revision pin करें, transfer speed सीमित करें और retry count स्पष्ट रूप से सेट करें:

openmed models pull disease_detection_superclinical \
  --revision main \
  --max-bandwidth 524288 \
  --retries 5

Progress में केवल repository filenames और byte/file totals होते हैं। Pull पूरा होने के बाद OPENMED_OFFLINE=1 सेट करें; वही command तब केवल cache lookup करता है और network connection का प्रयास नहीं करता।

5. दस्तावेज़ से कोड स्निपेट कॉपी करें¶

सभी कोड ब्लॉक में Material for MkDocs के कॉपी बटन उपलब्ध हैं। कमांड पैलेट (/ या cmd/ctrl + K) खोलकर “GLiNER,” “OpenMedConfig,” या “token classification” खोजें और पूर्वावलोकन में दिखा स्निपेट कॉपी करें। यदि आप AI कोडिंग सहायक का उपयोग करते हैं, तो उसे प्रकाशित दस्तावेज़ URL दें, ताकि वह इसी संरचित Markdown को पढ़े और प्रामाणिक उत्तर दिखाए।

6. वैकल्पिक: कॉन्फ़िगरेशन पिन करें¶

from openmed.core import OpenMedConfig, ModelLoader

config = OpenMedConfig.from_env_fallback(
    cache_dir="~/.cache/openmed",
    device="cuda",
    default_org="OpenMed",
)
loader = ModelLoader(config=config)
ner = loader.create_pipeline("disease_detection_superclinical")
entities = ner("Hydroxyurea dose reduced after platelet drop.")

संपूर्ण YAML/ENV स्कीमा, PHI-सचेत सत्यापन सहायक और लॉगिंग सेटअप के लिए कॉन्फ़िगरेशन अनुभाग पर जाएँ।