diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index 8f472bafbce2..f9dffc6089f6 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -1,9 +1,9 @@ Quick start =========== -Welcome to Ignite quick start guide that just gives essentials of getting a project up and running. +Welcome to **PyTorch-Ignite** quick start guide that just covers the essentials of getting a project up and walking through the code. -In several lines you can get your model training and validating: +In several lines of this given code, you can get your model trained and validated as shown below: Code ---- @@ -47,12 +47,12 @@ Code trainer.run(train_loader, max_epochs=100) -Complete code can be found in the file `examples/mnist/mnist.py `_. +**Note**: Complete code can be found in the file `examples/mnist/mnist.py `_. Explanation ----------- -Now let's break up the code and review it in details. In the first 4 lines we define our model, training and validation +Now let's break up the code and review it in details. In the first 4 lines, we define our model, training and validation datasets (as `torch.utils.data.DataLoader `_), optimizer and loss function: .. code-block:: python @@ -62,7 +62,7 @@ datasets (as `torch.utils.data.DataLoader