Skip to content

Commit

Permalink
update readmes
Browse files Browse the repository at this point in the history
Signed-off-by: Oleksii Kuchaiev <[email protected]>
  • Loading branch information
okuchaiev committed Jun 9, 2021
1 parent 45f72b0 commit 2763c67
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,10 @@ Documentation
:scale: 100%
:target: https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/main/

.. |v1.0.0| image:: https://readthedocs.com/projects/nvidia-nemo/badge/?version=v1.0.0
.. |v1.0.1| image:: https://readthedocs.com/projects/nvidia-nemo/badge/?version=v1.0.1
:alt: Documentation Status
:scale: 100%
:target: https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/v1.0.0/
:target: https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/v1.0.1/

.. |stable| image:: https://readthedocs.com/projects/nvidia-nemo/badge/?version=stable
:alt: Documentation Status
Expand All @@ -74,14 +74,14 @@ Documentation
+=========+=============+==================================================================================================================================+
| Latest | |main| | `Documentation of the latest (i.e. main) branch. <https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/main/>`_ |
+---------+-------------+----------------------------------------------------------------------------------------------------------------------------------+
| Next | |v1.0.0| | `Documentation of the most recent release: v1.0.0 <https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/v1.0.0/>`_ |
| Next | |v1.0.1| | `Documentation of the most recent release: v1.0.1 <https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/v1.0.1/>`_ |
+---------+-------------+----------------------------------------------------------------------------------------------------------------------------------+
| Stable | |stable| | `Documentation of the stable (i.e. stable) branch. <https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/stable/>`_ |
+---------+-------------+----------------------------------------------------------------------------------------------------------------------------------+

Tutorials
---------
A great way to start with NeMo is by checking `one of our tutorials <https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/v1.0.0/starthere/tutorials.html>`_.
A great way to start with NeMo is by checking `one of our tutorials <https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/v1.0.1/starthere/tutorials.html>`_.

Getting help with NeMo
----------------------
Expand Down
6 changes: 3 additions & 3 deletions docs/source/starthere/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Before you begin using NeMo, it's assumed you meet the following prerequisites.

#. You have Pytorch version 1.8.1.

#. You have access to a Volta, Turing, or an NVIDIA Ampere architecture-based A100 GPU for training.
#. You have access to an NVIDIA GPU for training.

.. _quick_start_guide:

Expand Down Expand Up @@ -116,8 +116,8 @@ Use this installation mode if you want the version from a particular GitHub bran
apt-get update && apt-get install -y libsndfile1 ffmpeg
pip install Cython
python -m pip install git+https://github.com/NVIDIA/NeMo.git@{BRANCH}#egg=nemo_toolkit[all]
# For v1.0.0, replace {BRANCH} with v1.0.0 like so:
# python -m pip install git+https://github.com/NVIDIA/[email protected].0#egg=nemo_toolkit[all]
# For v1.0.1, replace {BRANCH} with v1.0.1 like so:
# python -m pip install git+https://github.com/NVIDIA/[email protected].1#egg=nemo_toolkit[all]
From source
~~~~~~~~~~~
Expand Down

0 comments on commit 2763c67

Please sign in to comment.