Skip to content

[3/x] docs update: make docs landing page be like the main README#3761

Merged
vkuzo merged 9 commits intomainfrom
gh/vkuzo/200/head
Jan 29, 2026
Merged

[3/x] docs update: make docs landing page be like the main README#3761
vkuzo merged 9 commits intomainfrom
gh/vkuzo/200/head

Conversation

@vkuzo
Copy link
Copy Markdown
Contributor

@vkuzo vkuzo commented Jan 29, 2026

Summary:

  1. move the current "docs landing page" content to a tutorial, as it's
    really a tutorial
  2. duplicate the README.md's landing page content to docs, as this
    content has been kept up to date and is clear

for now duplicating (2), in a future PR I might make it import instead

in a future PR we should also update the landing page content to include
training, QAT and inference, not doing here to keep things short

Test Plan: look at docs in CI

vkuzo added 6 commits January 28, 2026 18:26
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
vkuzo added a commit that referenced this pull request Jan 29, 2026
Summary:

1. move the current "docs landing page" content to a tutorial, as it's
   really a tutorial
2. duplicate the README.md's landing page content to docs, as this
   content has been kept up to date and is clear

for now duplicating (2), in a future PR I might make it import instead

in a future PR we should also update the landing page content to include
training, QAT and inference, not doing here to keep things short

Test Plan: look at docs in CI
ghstack-source-id: 77cb432
ghstack-comment-id: 3819509141
Pull-Request: #3761
@pytorch-bot
Copy link
Copy Markdown

pytorch-bot bot commented Jan 29, 2026

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/ao/3761

Note: Links to docs will display an error until the docs builds have been completed.

⏳ No Failures, 7 Pending

As of commit bd528dd with merge base 57b1710 (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@vkuzo vkuzo mentioned this pull request Jan 29, 2026
@meta-cla meta-cla bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jan 29, 2026
@vkuzo vkuzo added the topic: documentation Use this tag if this PR adds or improves documentation label Jan 29, 2026
@github-actions
Copy link
Copy Markdown
Contributor

📄 Doc Preview (workflow_dispatch)

You triggered a doc build manually via workflow_dispatch.
The pytorchbot doc preview link will not work for this build.

Use this link instead: https://docs-preview.pytorch.org/pytorch/ao/21491126743/index.html

vkuzo added 3 commits January 29, 2026 20:13
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
@vkuzo vkuzo changed the base branch from gh/vkuzo/199/head to main January 29, 2026 20:14
pip install torchao --index-url https://download.pytorch.org/whl/cu126 # CUDA 12.6
pip install torchao --index-url https://download.pytorch.org/whl/cu129 # CUDA 12.9
pip install torchao --index-url https://download.pytorch.org/whl/xpu # XPU
pip install torchao --index-url https://download.pytorch.org/whl/cpu # CPU only
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

should we include instructions on installing dependencies as well? like mslk

@vkuzo vkuzo merged commit 142c32c into main Jan 29, 2026
55 of 56 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. topic: documentation Use this tag if this PR adds or improves documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants