Skip to content

[Skill] api-check: Validate API exports and import paths #51

Description

@sunway513

Skill

api-check

Priority: P2 (Medium — prevents documentation drift and import errors)

Motivation

AITER's public API surface is defined by __init__.py re-exports, but these frequently drift from actual function signatures and documentation. Common issues: functions exist in submodules but aren't re-exported (requiring from aiter.mla import instead of from aiter import), documentation references internal Triton kernel names instead of exported wrappers, and parameter names in docs don't match actual signatures. This causes user confusion and silent import failures.

What This Skill Should Do

  1. Scan init.py: Parse all re-exports in aiter/__init__.py and build the official public API surface
  2. Cross-reference submodules: Identify functions in submodules (mla, ops, jit) that are commonly used but NOT re-exported
  3. Signature audit: For each exported function, verify the actual signature matches what documentation claims
  4. Import path validation: Check all from aiter import X statements in documentation and examples — flag any that would fail at runtime
  5. Generate report: Output a coverage report showing: exported APIs, missing re-exports, signature mismatches, and broken doc imports

Acceptance Criteria

  • Can parse aiter/init.py and list all public exports
  • Can detect functions used in ATOM/examples but not re-exported from aiter
  • Can compare documented parameter names against actual function signatures
  • Can validate all import paths in docs/ markdown files
  • Produces actionable report: which exports to add, which docs to fix
  • Recommends exported API names (not Triton internals) for documentation

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions