Skip to content

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
wants to merge 17 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,11 @@ The APIs and performance characteristics of these features may change.
:glob:
:maxdepth: 2

Install PyTorch <https://pytorch.org/get-started/locally/>
user_guide/index
pytorch-api
notes
```

```{toctree}
:glob:
:hidden:
:maxdepth: 2

community/index
C++ <https://docs.pytorch.org/cppdocs/>
```

## Indices and tables
Expand Down
9 changes: 8 additions & 1 deletion docs/source/pytorch-api.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
(pytorch_api)=
# Python API
# Reference API

```{toctree}
:maxdepth: 1

C++ <https://docs.pytorch.org/cppdocs/>
```

```{toctree}
:glob:
:maxdepth: 1
:caption: Python API

torch
nn
Expand Down
39 changes: 39 additions & 0 deletions docs/source/user_guide/index.md
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
```
29 changes: 29 additions & 0 deletions docs/source/user_guide/pytorch_main_components.md
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
Copy link
Collaborator

Choose a reason for hiding this comment

The 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

Copy link
Collaborator

Choose a reason for hiding this comment

The 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).
Loading