Skip to content

[7/x] docs update: float8 training api reference#3765

Merged
vkuzo merged 30 commits into
mainfrom
gh/vkuzo/204/head
Jan 30, 2026
Merged

[7/x] docs update: float8 training api reference#3765
vkuzo merged 30 commits into
mainfrom
gh/vkuzo/204/head

Conversation

@vkuzo

@vkuzo vkuzo commented Jan 29, 2026

Copy link
Copy Markdown
Contributor

Summary:

  1. move training code sample from float8 readme to
    convert_to_float8_training docblock, so that it renders in the docs
  2. make sure all enums have docblocks

Test Plan: look at docs in CI

vkuzo added 20 commits January 28, 2026 18:26
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
@pytorch-bot

pytorch-bot Bot commented Jan 29, 2026

Copy link
Copy Markdown

🔗 Helpful Links

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

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

❗ 1 Active SEVs

There are 1 currently active SEVs. If your PR is affected, please view them below:

✅ No Failures

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

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

vkuzo added a commit that referenced this pull request Jan 29, 2026
Summary:

1. move training code sample from float8 readme to
   convert_to_float8_training docblock, so that it renders in the docs
2. make sure all enums have docblocks

Test Plan: look at docs in CI
ghstack-source-id: 69d8981
ghstack-comment-id: 3820319363
Pull-Request: #3765
@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
vkuzo added 10 commits January 29, 2026 21:14
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
@vkuzo vkuzo merged commit 50865d5 into main Jan 30, 2026
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