Skip to content

Commit 1a2d83c

Browse files
pietsjohfnhirwa
andauthored
[DOC] Fix typos in getting started section of the documentation (#1399)
### Description Fixes some typos in the getting started section of the documentation. There is also a broken link (line 54, favourite package). After a brief look at the documentation of pytorch lightning, I am not really sure with that should be replaced. So feel free to add a commit with the corrected link. Otherwise I could also open an issue for that. Just let me know :) ### Checklist - [ ] Linked issues (if existing) - [ ] Amended changelog for large changes (and added myself there as contributor) - [ ] Added/modified tests - [ ] Used pre-commit hooks when committing to ensure that code is compliant with hooks. Install hooks with `pre-commit install`. To run hooks independent of commit, execute `pre-commit run --all-files` Make sure to have fun coding! Co-authored-by: Felix Hirwa Nshuti <[email protected]>
1 parent 6d64360 commit 1a2d83c

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

docs/source/getting-started.rst

+3-4
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,11 @@ Otherwise, you can proceed with
2323
2424
2525
Alternatively, to install the package via ``conda``:
26-
2726
.. code-block:: bash
2827
2928
conda install pytorch-forecasting pytorch>=1.7 -c pytorch -c conda-forge
3029
31-
PyTorch Forecasting is now installed from the conda-forge channel while PyTorch is install from the pytorch channel.
30+
PyTorch Forecasting is now installed from the conda-forge channel while PyTorch is installed from the pytorch channel.
3231

3332
To use the MQF2 loss (multivariate quantile loss), also install
3433

@@ -54,7 +53,7 @@ The general setup for training and testing a model is
5453
Similarly, a test dataset or later a dataset for inference can be created. You can store the dataset parameters
5554
directly if you do not wish to load the entire training dataset at inference time.
5655

57-
#. Instantiate a model using the its ``.from_dataset()`` method.
56+
#. Instantiate a model using the ``.from_dataset()`` method.
5857
#. Create a ``lightning.Trainer()`` object.
5958
#. Find the optimal learning rate with its ``.tuner.lr_find()`` method.
6059
#. Train the model with early stopping on the training dataset and use the tensorboard logs
@@ -65,7 +64,7 @@ The general setup for training and testing a model is
6564
#. Load the model from the model checkpoint and apply it to new data.
6665

6766

68-
The :ref:`Tutorials <tutorials>` section provides detailled guidance and examples on how to use models and implement new ones.
67+
The :ref:`Tutorials <tutorials>` section provides detailed guidance and examples on how to use models and implement new ones.
6968

7069

7170
Example

0 commit comments

Comments
 (0)