-
Notifications
You must be signed in to change notification settings - Fork 24.9k
Add placeholder for the User Guide #159379
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
Open
svekars
wants to merge
17
commits into
main
Choose a base branch
from
add-user-guide-structure
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+78
−9
Open
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
4dddf07
Add placeholder for the User Guide
svekars 8c8ae0e
Update
svekars df39c71
Fix lint
svekars 7ede97b
Update
svekars 7e6d84d
Update index.md
svekars 7cf97d2
Update pytorch_overview.md
svekars 24f0a6a
Update index.md
svekars 72ec1e4
Addressed comments - added links to corresponding docs
svekars 30d65d3
Update docs/source/user_guide/pytorch_main_components.md
sekyondaMeta 16c070f
Update index.md
sekyondaMeta 6328675
Update pytorch_main_components.md
sekyondaMeta cf19dc1
Update index.md
sekyondaMeta 0840b2c
Update pytorch_overview.md
sekyondaMeta 838b85d
Update pytorch_overview.md
sekyondaMeta 2621566
Update pytorch_main_components.md
sekyondaMeta b7adca6
Update index.md
sekyondaMeta bfbe0fd
Delete docs/source/user_guide/pytorch_overview.md
sekyondaMeta File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# User Guide | ||
|
||
PyTorch provides a flexible and efficient platform for building deep | ||
learning models, offering dynamic computation graphs and a rich | ||
ecosystem of tools and libraries. This guide will help you harness the power | ||
of PyTorch to create and deploy machine learning models effectively. | ||
|
||
```{note} | ||
This guide is a work in progress. | ||
``` | ||
|
||
```{toctree} | ||
:maxdepth: 1 | ||
:caption: Introduction | ||
|
||
Pytorch Overview <https://docs.pytorch.org/tutorials/beginner/deep_learning_60min_blitz.html> | ||
Get Started <https://pytorch.org/get-started/locally/> | ||
Learn the Basics <https://docs.pytorch.org/tutorials/beginner/basics/intro.html> | ||
``` | ||
|
||
```{toctree} | ||
:maxdepth: 1 | ||
:caption: Core Concepts | ||
|
||
pytorch_main_components | ||
``` | ||
|
||
```{toctree} | ||
:maxdepth: 1 | ||
:caption: Beyond the Basics | ||
|
||
``` | ||
|
||
```{toctree} | ||
:maxdepth: 1 | ||
:caption: Developer Notes | ||
|
||
../notes | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
(pytorch_main_components)= | ||
# PyTorch Main Components | ||
|
||
PyTorch is a flexible and powerful library for deep learning that provides a comprehensive set of tools for building, training, and deploying machine learning models. | ||
|
||
## PyTorch Components for Basic Deep Learning | ||
|
||
Some of the basic PyTorch components include: | ||
|
||
* **Tensors** - N-dimensional arrays that serve as PyTorch's fundamental | ||
data structure. They support automatic differentiation, hardware acceleration, and provide a comprehensive API for mathematical operations. | ||
|
||
* **Autograd** - PyTorch's automatic differentiation engine | ||
that tracks operations performed on tensors and builds a computational | ||
graph dynamically to be able to compute gradients. | ||
|
||
* **Neural Network API** - A modular framework for building neural networks with pre-defined layers, | ||
activation functions, and loss functions. The {mod}`nn.Module` base class provides a clean interface | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. these don't really work as links. Not sure if that's expected There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removed them for now |
||
for creating custom network architectures with parameter management. | ||
|
||
* **DataLoaders** - Tools for efficient data handling that provide | ||
features like batching, shuffling, and parallel data loading. They abstract away the complexities | ||
of data preprocessing and iteration, allowing for optimized training loops. | ||
|
||
|
||
## PyTorch Compiler | ||
|
||
The PyTorch compiler is a suite of tools that optimize model execution and | ||
reduce resource requirements. You can learn more about the PyTorch compiler [here](https://docs.pytorch.org/docs/stable/torch.compiler_get_started.html). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.