Jump to content

Connect SuperML | Leeroopedia MCP: Equip your AI agents with best practices, code verification, and debugging knowledge. Powered by Leeroo — building Organizational Superintelligence. Contact us at founders@leeroo.com.

Implementation:Huggingface Transformers Check Inits

From Leeroopedia
Knowledge Sources
Domains Code_Quality, Import_System
Last Updated 2026-02-13 20:00 GMT

Overview

Concrete tool for validating that Transformers lazy-loading __init__.py files have consistent definitions between the _import_structure dictionary and the TYPE_CHECKING block.

Description

The check_inits.py utility parses init files using regex patterns to extract object names from both the _import_structure dictionary definitions (used at runtime for lazy loading) and the TYPE_CHECKING import block (used by static type checkers and IDEs). It compares the two sets to find objects present in one but missing from the other. Also checks that all submodules are registered as keys in _import_structure to ensure importability. Has no auto-fix mode; all inconsistencies must be fixed manually.

Usage

Run as part of make check-repo to validate init file consistency.

Code Reference

Source Location

Signature

def find_backend(line: str) -> Optional[str]:
    """Detect which backend guard a line is under (torch, tf, etc.)."""

def parse_init(init_file: str) -> Tuple[Dict, Dict]:
    """Parse _import_structure and TYPE_CHECKING blocks from an init file."""

def analyze_results(
    import_structure: Dict,
    type_checking: Dict,
) -> List[str]:
    """Compare the two dicts and return list of inconsistencies."""

def check_submodules() -> List[str]:
    """Check that all submodules are registered in _import_structure."""

Import

python utils/check_inits.py

I/O Contract

Inputs

Name Type Required Description
src/transformers/**/__init__.py Python files Yes Init files to validate

Outputs

Name Type Description
Error report stdout Objects in _import_structure but not TYPE_CHECKING (or vice versa)
Exit code int 0 if consistent, 1 if inconsistencies found

Usage Examples

Checking Init Files

# Check all init files for consistency
python utils/check_inits.py

# Part of the full repo check
make check-repo

Related Pages

Page Connections

Double-click a node to navigate. Hold to expand connections.
Principle
Implementation
Heuristic
Environment