Skip to content

Document all four adapter registration locations#1514

Merged
jlarson4 merged 4 commits into
TransformerLensOrg:devfrom
abhinav-bellapu:codex/docs-four-place-adapter-registration
Jul 14, 2026
Merged

Document all four adapter registration locations#1514
jlarson4 merged 4 commits into
TransformerLensOrg:devfrom
abhinav-bellapu:codex/docs-four-place-adapter-registration

Conversation

@abhinav-bellapu

Copy link
Copy Markdown
Contributor

Description

Closes #1511.

The adapter creation guide listed three registration locations while the formal adapter specification listed only two. Both disagreed with the existing four-place invariant in contributing.md and supported_architectures/AGENTS.md.

This change:

  • documents tools/model_registry/generate_report.py and ARCHITECTURE_DESCRIPTIONS as the fourth registration location;
  • adds the two missing model-registry locations to the adapter specification; and
  • updates the guide's final checklist and common-pitfall reminder to cover all four locations.

This keeps contributor instructions consistent and reduces the chance that a new adapter loads successfully but has incomplete discovery or generated reporting. No new dependencies are required.

Validation

  • uv run --locked --python 3.12 build-docs (succeeded; no warnings from the changed files)
  • make check-format
  • uv run --locked --python 3.12 mypy .

Type of change

  • This change requires a documentation update

Checklist

  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • No code behavior or interfaces were changed
  • I have not rewritten tests relating to key interfaces which would affect backward compatibility

@abhinav-bellapu abhinav-bellapu marked this pull request as ready for review July 13, 2026 21:32
@abhinav-bellapu

Copy link
Copy Markdown
Contributor Author

@jlarson4 ready for review

@jlarson4 jlarson4 merged commit d7de49c into TransformerLensOrg:dev Jul 14, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants