Welcome to ETUDE Engine’s documentation!

HIgh-Level Content:

• Documentation
• Sample Runs
  • Basic Run
  • Specifying Annotation Configs
  • Scoring on Different Fields
• Custom Evaluation Print-Outs
  • Contextually-Grounded Annotation Examples
• Configuring Annotation Extraction
• Dependencies
• Building with PyInstaller
• Testing
• API Documentation
  • args_and_configs.py Functions
  • etude.py Functions
  • scoring_metrics.py Functions
  • text_extraction.py Functions

In-Depth Content:

• Configuration Files
  • Score Keys
  • Score Values
• Input Formats & Support Details
  • Simple Plain Text
  • Structured Plain Text (e.g., csv)
  • XML Formats
• Evaluating Matches
  • Exact Match
  • Partial Match
  • Fully-Contained Match
  • Start Match
  • End Match
  • Doc-Property Match
• Evaluating Normalization
• Evaluating Context Attributes
  • Sample Test Data
• Output Formats

Indices and tables

• Index
• Module Index
• Search Page