Skip to content

[Docs] Follow TileOPs' release renames, and drop register_kernel_type from the backend guides - #81

Merged
lcy-seso merged 1 commit into
tile-ai:mainfrom
lcy-seso:docs/release-renames
Oct 25, 2026
Merged

lcy-seso merged 1 commit into
tile-ai:mainfrom
lcy-seso:docs/release-renames

Conversation

@lcy-seso

Copy link
Copy Markdown
Contributor

Problems

Changes

  • API pages name the renamed ops; the trace page documents tileops.trace._api._Trace.
  • Links and paths point at src/tileops/_ops, _kernels and _perf; imports use tileops.<family>; spec and code excerpts follow the renamed classes and inputs.
  • Backend guides (English and Chinese) describe the target as the only way a backend joins; register_kernel_type and its figure node are gone. The figure SVGs were edited by hand; re-run figures/user-guide/render.sh for PlantUML's own layout.
  • The new-op pages point code outside TileOPs at tileops.authoring.
  • workload_shape.py uses tileops.manifest.entry_plan and instantiate; gen_bench_pages.py imports from tileops._perf and reads both tileops.ops and tileops._ops module paths, since older nightly snapshots carry the old one.
  • The Architecture page leaves the nav and redirects to the Design index; design pages' ../<doc> links resolve to GitHub.
  • Verified against TileOPs main: ruff, pytest (10 passed), check_api_pages.py (206 ops, none missing), and mkdocs build with no warnings of ours.

… from the backend guides

tile-ai/TileOPs#2741 moves the internal packages under a leading underscore
(tileops._ops, _kernels, _perf, _utils), makes the submodules of
tileops.manifest, tileops.trace and tileops.backend private, renames 26 op
classes and many op inputs, and removes register_kernel_type from the backend
protocol. Against it the API pages name ops the build cannot collect, the
renderer imports modules that no longer exist, and the guides describe an
extension path a backend no longer has.

The API pages name the renamed ops, and the trace page documents
tileops.trace._api._Trace. Links and paths point at src/tileops/_ops,
_kernels and _perf, imports use tileops.<family>, and the spec and code
excerpts follow the renamed classes, call specs and inputs.

The backend guides describe the target as the only way a backend joins: the
comparison with register_kernel_type, its section and its node in the
extension figure are gone, in English and Chinese. The op guides name
_entries_built and _held_delegates, and the new-op page points code outside
TileOPs at tileops.authoring.

workload_shape.py takes entry_plan and instantiate from tileops.manifest;
picking a row's branch still needs the private _workload helpers, since
tileops.manifest exports no equivalent. gen_bench_pages.py imports
find_profile from tileops._perf and reads the family from both tileops.ops
and tileops._ops module paths, since older snapshots carry the old one.

tile-ai/TileOPs#2731, already on main, deleted docs/design/architecture.md and
added docs/code-style.md. The Architecture page leaves the nav and redirects
to the Design index, design pages' ../<doc> links resolve to GitHub, and the
PR-title types link points at scripts/ci/types.sh.
Copilot AI balanced review requested due to automatic review settings October 25, 2026 05:05

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

@lcy-seso
lcy-seso merged commit c047eab into tile-ai:main Oct 25, 2026
3 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