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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update and fix PyTorch docs #2137

Merged
merged 2 commits into from
Jan 21, 2024
Merged

Conversation

ArkciaDragone
Copy link
Contributor

  • Updated the versions and releases in the scraper file
  • Ensured the license is up-to-date
  • Ensured the icons and the SOURCE file in public/icons/your_scraper_name/ are up-to-date if the documentation has a custom icon
  • Ensured self.links contains up-to-date urls if self.links is defined
  • Tested the changes locally to ensure:
    • The scraper still works without errors
    • The scraped documentation still looks consistent with the rest of DevDocs
    • The categorization of entries is still good

The documentation for PyTorch has unfortunately been overlooked for quite some time. While the recent update #2117 was intended to include the latest and significant versions, it has rendered the docs hardly useful. Specifically, the webpage layout has undergone changes prior to the update, which have not been addressed within the update either, resulting in the generated docs missing a substantial number of entries.

Examples of missing entries for inspection:
torch.stack, torch.sin, torch.nn.Module, torch.nn.functional.relu, torch.cuda.is_available

This PR aims to address this issue and also provide a named categorization mapping (which was previously absent). Although the code may not be flawless, I made an effort to include as many entries as I could think of while maintaining a concise structure for the list.

The PyTorch License, found at https://github.com/pytorch/pytorch/blob/main/LICENSE, appears to be more intricate compared to a typical 3-clause BSD license. In consideration of my limited familiarity with this subject, please make any necessary edits.
As a first-time Ruby code writer, I kindly ask for your understanding and assistance in adjusting my code to meet the standards of the repository.

@ArkciaDragone ArkciaDragone requested a review from a team as a code owner January 21, 2024 04:39
Copy link
Contributor

@simon04 simon04 left a comment

Choose a reason for hiding this comment

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

Great, thank you!

@simon04 simon04 merged commit ae9d1ce into freeCodeCamp:main Jan 21, 2024
1 check passed
@ArkciaDragone ArkciaDragone deleted the pytorch-fix branch January 22, 2024 02:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants