pytorch / pytorch/pytorch.github.io

Doc-strings are truncated on "non-linear-activations-weighted-sum-nonlinearity" page on pytorch.org

Open
#684 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
285
Forks
317
PR merge metrics
No merged PRs in 30d

Description

📚 Documentation

On a pytorch ops listing on a pytorch.org page their doc-strings are truncated:

op doc
nn.Softplus Applies the element-wise function:
nn.Softshrink Applies the soft shrinkage function elementwise:

What follows "Applies the element-wise function" is an important part that is not displayed on this page.

Expected

op doc
nn.Softplus Applies the element-wise function: <function formula>
nn.Softshrink Applies the soft shrinkage function elementwise: <function formula>

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked pytorch.org documentation page at the non-linear-activations-weighted-sum-nonlinearity anchor and inspect how the nn.Softplus and nn.Softshrink entries are generated or rendered. Trace the documentation listing source from that entry point, then verify that both entries display their complete function formulas rather than stopping after the introductory text.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.