Skip to content

API Reference

This section contains the complete API documentation for Glazing, automatically generated from the source code.

Package Organization

The Glazing package is organized into several submodules:

Core Modules

Dataset Modules

  • FrameNet - Semantic frames and frame elements
  • PropBank - Predicate-argument structures
  • VerbNet - Verb classes and thematic roles
  • WordNet - Synsets and lexical relations

Cross-Reference Module

Utility Modules

  • Utils - Shared utilities and helpers
  • CLI - Command-line interface implementation

Quick Navigation

By Functionality

Data Loading

Data Conversion

Searching

Cross-References

Usage Examples

Basic Import

from glazing.search import UnifiedSearch
from glazing.framenet.loader import FrameNetLoader
from glazing.references.resolver import ReferenceResolver

Loading Data

from pathlib import Path
from glazing.verbnet.loader import VerbNetLoader

loader = VerbNetLoader(Path("data/verbnet.jsonl"))
verb_classes = loader.load_verb_classes()

Searching

from glazing.search import UnifiedSearch

search = UnifiedSearch()
results = search.search("abandon")

Type Safety

All models use Pydantic v2 for validation and provide complete type hints. This ensures:

  • Runtime validation of data
  • IDE autocomplete support
  • Static type checking with mypy
  • Automatic documentation generation

Performance Considerations

  • Streaming: All loaders support streaming for memory-efficient processing
  • Caching: Search indices are cached for repeated queries
  • Lazy Loading: Data is loaded on-demand where possible
  • JSON Lines: Efficient line-based format for large datasets

Error Handling

All modules follow consistent error handling patterns:

try:
    frames = loader.load_frames(path)
except FileNotFoundError:
    print("Data file not found")
except ValidationError as e:
    print(f"Invalid data: {e}")

Version Compatibility

This documentation covers glazing version 0.2.3. Check your installed version:

import glazing
print(glazing.__version__)