Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
julian-fong committed Nov 1, 2024
1 parent 55ac231 commit 81ffaa9
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
1 change: 1 addition & 0 deletions docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ If you are working Windows, you need to first install PyTorch with
pip install torch -f https://download.pytorch.org/whl/torch_stable.html
Otherwise, you can proceed with

.. code-block:: bash
pip install pytorch-forecasting
Expand Down
9 changes: 5 additions & 4 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ Installation
``pytorch-forecasting`` currently supports:

* Python versions 3.8, 3.9, 3.10, 3.11, and 3.12.
* Operating systems : ... ... and ...
* Operating systems : Linux, macOS, and Windows

Installing pytorch-forecasting
------------------------------

``pytorch-forecasting`` is a library build off of the popular deep learning framework ``pytorch`` and
``pytorch-forecasting`` is a library built on top of the popular deep learning framework ``pytorch`` and
heavily uses the Pytorch Lightning library ``lightning`` for ease of training and multiple GPU usage.

You'll need to install ``pytorch`` along or before with ``pytorch-forecasting`` in order to get a working
Expand All @@ -34,9 +34,10 @@ Otherwise, you can proceed with:
Alternatively, to install the package via ``conda``:

.. code-block:: bash
conda install pytorch-forecasting pytorch>=1.7 -c pytorch -c conda-forge
conda install pytorch-forecasting pytorch>=2.0.0 -c pytorch -c conda-forge
PyTorch Forecasting is now installed from the conda-forge channel while PyTorch is install from the pytorch channel.

Expand Down Expand Up @@ -174,7 +175,7 @@ review your contributions/pull requests, please read the following guidelines be
adding a feature, or improving code, [BUG] - Bugfixes, [MNT] - CI: test framework, [DOC] -
Documentation: writing or improving documentation or docstrings.

* Adding references to other links or pull requests
* Adding references to other links or pull requests.
This helps to add context about previous or current issues/prs that relate to
your contribution. This is done usually by including a full link or a hash tag '#1234'.

Expand Down

0 comments on commit 81ffaa9

Please sign in to comment.