docs: Update outdated documentation pages#28791
Conversation
|
@copilot I think you need to rebase on the gh-pages branch |
- install/index.md: Add WebGPU EP installation instructions for JavaScript/web - get-started/community-projects.md: Clarify Rust API availability - get-started/training-pytorch.md: Update outdated torch-ort installation (use onnxruntime-training directly) - performance/model-optimizations/ort-format-models.md: Update backwards compatibility table (1.14+ -> 1.15+) - reference/operators/index.md: Add meaningful content to empty operators index page - tutorials/accelerate-pytorch/pytorch.md: Fix torch.onnx.export argument order in example - get-started/with-python.md: Update CUDA 11.8 section and remove outdated nightly build links - get-started/with-windows.md: Remove outdated DirectML API contract version table
504c196 to
4672583
Compare
Done — rebased onto |
There was a problem hiding this comment.
@MaanavD I wonder if we should just remove this page?
|
@copilot is it possible to update the deployment script to show an last updated tag under the doc page titles? How hard would this be? |
It's definitely doable, but it would require a few coordinated changes and is probably a medium-effort task:
The main complication is that the layout override needs to stay in sync with upstream |
Description
Updates several stale pages on the ONNX Runtime documentation site (sourced from the
gh-pagesbranch), addressing missing content, deprecated APIs, and outdated version information.Changes by page:
docs/install/index.md— Adds WebGPU EP install instructions: how to useonnxruntime-web/webgpuimport and theort.webgpu.min.jsscript tag for browser usage.docs/get-started/community-projects.md— Separates Rust from the Julia/Ruby community section; documents theortcrate as the Rust API for ONNX Runtime with aCargo.tomlsnippet.docs/get-started/training-pytorch.md— Removes the deprecatedtorch-ort/python -m torch_ort.configureflow; replaces withpip install onnxruntime-trainingand the correctonnxruntime.training.ortmodule.ORTModuleimport path.docs/performance/model-optimizations/ort-format-models.md— Extends the backwards compatibility table to include 1.15+ (no breaking changes from 1.14).docs/reference/operators/index.md— Fills in the previously empty operators index with descriptions of full vs. reduced builds, contrib ops, mobile ops, and links to custom operator guides.docs/tutorials/accelerate-pytorch/pytorch.md— Fixes argument order intorch.onnx.exportexample:(model, PATH, example)→(model, example, "model.onnx").docs/get-started/with-python.md— Updates CUDA 11.8 header to CUDA 11.x; removes stale nightly feed entries from the Builds table.docs/get-started/with-windows.md— Removes the outdated API contract version table (Windows OS 1809/1903/1909, ORT 1.2–1.4).Motivation and Context
Several documentation pages listed in the issue were missing information (WebGPU install, Rust API), referencing deprecated packages (
torch-ort), or showing obsolete version tables. These updates bring the affected pages in line with current ORT capabilities and recommended practices.