Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Layout Error in API Documentation for FunctionCtx.mark_non_differentiable. #125919

Closed
Zoeeeeey opened this issue May 10, 2024 · 1 comment 路 Fixed by pytorch/pytorch_sphinx_theme#196
Assignees
Labels
module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module

Comments

@Zoeeeeey
Copy link

Zoeeeeey commented May 10, 2024

馃摎 The doc issue

Hi,

In the API documentation for the FunctionCtx.mark_non_differentiable function, the font overlaps due to the lengthy title torch.autograd.function.FunctionCtx.mark_non_differentiable.

https://pytorch.org/docs/stable/generated/torch.autograd.function.FunctionCtx.mark_non_differentiable.html#

image

image

This issue might also occur in other API documents with similarly long titles. The display is abnormal in both Edge and Google browsers.

I couldn't find the correct channel to report this documentation error, so I am reporting it here. I apologize if this is not the right place for submission.

Congratulations on the new release of torch!

Suggest a potential alternative/fix

No response

cc @svekars @brycebortree

@soulitzer soulitzer added module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module labels May 10, 2024
@svekars svekars self-assigned this May 10, 2024
@Zoeeeeey
Copy link
Author

Below is another API document where I have encountered similar issues.

torch.nn.modules.module.register_module_full_backward_hook
https://pytorch.org/docs/stable/generated/torch.nn.modules.module.register_module_full_backward_hook.html#torch-nn-modules-module-register-module-full-backward-hook
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
None yet
3 participants