Skip to content

docs: update Python style docs to Ruff, remove TVM EP artifacts#28040

Open
MaanavD wants to merge 1 commit intomicrosoft:mainfrom
MaanavD:agents/retired-sloth
Open

docs: update Python style docs to Ruff, remove TVM EP artifacts#28040
MaanavD wants to merge 1 commit intomicrosoft:mainfrom
MaanavD:agents/retired-sloth

Conversation

@MaanavD
Copy link
Copy Markdown
Contributor

@MaanavD MaanavD commented Apr 11, 2026

Description

Fixes documentation discrepancies found by comparing in-repo docs against actual codebase configuration.

Python Code Style docs (docs/Coding_Conventions_and_Standards.md)

  • Black → Ruff: The docs recommended Black and isort, but the actual formatter/linter configured in .lintrunner.toml and requirements-lintrunner.txt is Ruff
  • Removed stale pydocstyle recommendation (not configured in lintrunner or installed)
  • Updated PyCharm section to link to Ruff docs instead of Black docs
  • Fixed typo: "development is VS Code" → "development in VS Code"

TVM EP cleanup

The TVM Execution Provider was removed in Nov 2024 (commit 13346fdf18), but a few artifacts remained:

  • Removed kTvmExecutionProvider constant from include/onnxruntime/core/graph/constants.h (no code references it)
  • Removed commented-out DefaultTvmExecutionProvider() declaration from default_providers.h
  • Removed dead test_tvm_imported test method from onnxruntime_test_python.py

Note: The available_providers_without_tvm variable in onnxruntime_test_python.py is used in ~15 places. Since TVM EP is removed, the filter is a harmless no-op. Cleaning that up is a larger refactor best done separately.

Motivation and Context

Audited all major in-repo documentation against the actual codebase. The C API Guidelines, OperatorKernels.md, ContribOperators.md, Versioning.md, and PR Guidelines were all verified as accurate. Only the Python style section and TVM EP remnants were out of date.

- Update Coding_Conventions_and_Standards.md: replace Black/isort references
  with Ruff (the actual formatter/linter configured in .lintrunner.toml)
- Remove stale pydocstyle recommendation (not configured in lintrunner)
- Fix typo: 'development is VS Code' -> 'development in VS Code'
- Update PyCharm section to link Ruff docs instead of Black docs
- Remove kTvmExecutionProvider constant from constants.h (TVM EP removed)
- Remove commented-out DefaultTvmExecutionProvider() declaration
- Remove dead test_tvm_imported test method

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.

1 participant