diff --git a/docs/source/index.md b/docs/source/index.md index e1e8ce5c0f2e..df012d1d6e17 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -23,17 +23,11 @@ The APIs and performance characteristics of these features may change. :glob: :maxdepth: 2 +Install PyTorch +user_guide/index pytorch-api notes -``` - -```{toctree} -:glob: -:hidden: -:maxdepth: 2 - community/index -C++ ``` ## Indices and tables diff --git a/docs/source/pytorch-api.md b/docs/source/pytorch-api.md index 1083354f3b3c..6ebf94c47a35 100644 --- a/docs/source/pytorch-api.md +++ b/docs/source/pytorch-api.md @@ -1,9 +1,16 @@ (pytorch_api)= -# Python API +# Reference API + +```{toctree} +:maxdepth: 1 + +C++ +``` ```{toctree} :glob: :maxdepth: 1 +:caption: Python API torch nn diff --git a/docs/source/user_guide/index.md b/docs/source/user_guide/index.md new file mode 100644 index 000000000000..c07f50c0e8b0 --- /dev/null +++ b/docs/source/user_guide/index.md @@ -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 +Get Started +Learn the Basics +``` + +```{toctree} +:maxdepth: 1 +:caption: Core Concepts + +pytorch_main_components +``` + +```{toctree} +:maxdepth: 1 +:caption: Beyond the Basics + +``` + +```{toctree} +:maxdepth: 1 +:caption: Developer Notes + +../notes +``` diff --git a/docs/source/user_guide/pytorch_main_components.md b/docs/source/user_guide/pytorch_main_components.md new file mode 100644 index 000000000000..809fafaf8235 --- /dev/null +++ b/docs/source/user_guide/pytorch_main_components.md @@ -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 +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).