pytorch / pytorch/pytorch.github.io

Unknown intention of link in "Understanding GPU Memory 1: Visualizing All Allocations over Time"

Open
#1,535 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

In Understanding GPU Memory 1: Visualizing All Allocations over Time there's a link to an html file in github that may have been intended to show graphs but instead shows nothing with the following github message: Sorry about that, but we can’t show files that are this big right now.

edit: OK, I continued reading and it explains how to use the file. I'd suggest changing the wording from "Try it yourself at https://github.com/pytorch/pytorch.github.io/blob/site/assets/images/understanding-gpu-memory-1/snapshot.html." to something that doesn't imply that there's supposed to be a working example on github.

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

Review the linked article and the snapshot.html link, focusing on the wording "Try it yourself at...". Update the wording so it does not imply that GitHub displays a working example, then verify the rendered article still explains how to use the file.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.