Skip to content

Commit 43ed450

Browse files
authored
Fix torch/cuda/python versions in the doc. (#918)
* Fix torch/cuda/python versions in the doc. * Minor fixes.
1 parent 9e7b2a9 commit 43ed450

16 files changed

+26
-39
lines changed

docs/source/installation/conda.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,13 @@ Read the following if you want to learn more.
5757
Supported versions
5858
------------------
5959

60-
.. |conda_python_versions| image:: ./images/python-3.6_3.7_3.8-blue.svg
60+
.. |conda_python_versions| image:: ./images/python_ge_3.6-blue.svg
6161
:alt: Supported python versions
6262

63-
.. |conda_cuda_versions| image:: ./images/cuda-10.1_10.2_11.0_11.1-orange.svg
63+
.. |conda_cuda_versions| image:: ./images/cuda_ge_10.1-orange.svg
6464
:alt: Supported cuda versions
6565

66-
.. |conda_pytorch_versions| image:: ./images/pytorch-1.6.0_1.7.0_1.7.1_1.8.0_1.8.1-green.svg
66+
.. |conda_pytorch_versions| image:: ./images/pytorch_ge_1.5.0-green.svg
6767
:alt: Supported pytorch versions
6868

6969
- |conda_python_versions|

docs/source/installation/from_source.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ The following versions of Python, CUDA, and PyTorch are known to work.
99
- |source_cuda_versions|
1010
- |source_pytorch_versions|
1111

12-
.. |source_python_versions| image:: ./images/source_python-3.6_3.7_3.8_3.9-blue.svg
12+
.. |source_python_versions| image:: ./images/python_ge_3.6-blue.svg
1313
:alt: Supported python versions
1414

15-
.. |source_cuda_versions| image:: ./images/source_cuda-10.1_10.2_11.0_11.1_11.2_11.3-orange.svg
15+
.. |source_cuda_versions| image:: ./images/cuda_ge_10.1-orange.svg
1616
:alt: Supported cuda versions
1717

18-
.. |source_pytorch_versions| image:: ./images/source_pytorch-1.6.0_1.7.0_1.7.1_1.8.0_1.8.1-green.svg
18+
.. |source_pytorch_versions| image:: ./images/pytorch_ge_1.5.0-green.svg
1919
:alt: Supported pytorch versions
2020

2121
Before compiling k2, some preparation work has to be done:

docs/source/installation/images/README.md

+3-11
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,10 @@
33

44
<https://shields.io/> is used to create the following files:
55

6-
- python-3.6_3.7_3.8-blue.svg
7-
- cuda-10.1_10.2_11.0_11.1-orange.svg
8-
- pytorch-1.6.0_1.7.0_1.7.1_1.8.0_1.8.1-green.svg
6+
- python_ge_3.6-blue.svg
7+
- cuda_ge_10.1-orange.svg
8+
- pytorch_ge_1.5.0-green.svg
99

1010
- pypi_python-3.6_3.7_3.8-blue.svg
1111
- pypi_cuda-10.1-orange.svg
1212
- pypi_pytorch-1.7.1-green.svg
13-
14-
- pip_python-3.6_3.7_3.8-blue.svg
15-
- pip_cuda-10.1_10.2_11.0-orange.svg
16-
- pip_pytorch-1.7.1-green.svg
17-
18-
- source_python-3.6_3.7_3.8_3.9-blue.svg
19-
- source_cuda-10.1_10.2_11.0_11.1-orange.svg
20-
- source_pytorch-1.6.0_1.7.0_1.7.1_1.8.0_1.8.1-green.svg

docs/source/installation/images/cuda-10.1_10.2_11.0_11.1-orange.svg

-1
This file was deleted.
Loading

docs/source/installation/images/pip_cuda-10.1_10.2_11.0-orange.svg

-1
This file was deleted.

docs/source/installation/images/pip_python-3.6_3.7_3.8-blue.svg

-1
This file was deleted.

docs/source/installation/images/pip_pytorch-1.7.1-green.svg

-1
This file was deleted.

docs/source/installation/images/python-3.6_3.7_3.8-blue.svg

-1
This file was deleted.
Loading
Loading

docs/source/installation/images/source_cuda-10.1_10.2_11.0_11.1_11.2_11.3-orange.svg

-1
This file was deleted.

docs/source/installation/images/source_python-3.6_3.7_3.8_3.9-blue.svg

-1
This file was deleted.

docs/source/installation/images/source_pytorch-1.6.0_1.7.0_1.7.1_1.8.0_1.8.1-green.svg

-1
This file was deleted.

docs/source/installation/index.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ below:
1414
- From conda (**recommended**)
1515

1616
- |conda_python_versions|
17-
- |conda_cuda_versions|-
17+
- |conda_cuda_versions|
1818
- |conda_pytorch_versions|
1919

2020
- From pip (k2-fsa.org)
@@ -26,7 +26,7 @@ below:
2626
- From pypi (pypi.org)
2727

2828
- |pypi_python_versions|
29-
- |pypi_cuda_versions|-
29+
- |pypi_cuda_versions|
3030
- |pypi_pytorch_versions|
3131

3232
- From source (**for advanced users**)
@@ -44,22 +44,22 @@ below:
4444
from_source
4545
for_developers
4646

47-
.. |conda_python_versions| image:: ./images/python-3.6_3.7_3.8-blue.svg
47+
.. |conda_python_versions| image:: ./images/python_ge_3.6-blue.svg
4848
:alt: Supported python versions
4949

50-
.. |conda_cuda_versions| image:: ./images/cuda-10.1_10.2_11.0_11.1-orange.svg
50+
.. |conda_cuda_versions| image:: ./images/cuda_ge_10.1-orange.svg
5151
:alt: Supported cuda versions
5252

53-
.. |conda_pytorch_versions| image:: ./images/pytorch-1.6.0_1.7.0_1.7.1_1.8.0_1.8.1-green.svg
53+
.. |conda_pytorch_versions| image:: ./images/pytorch_ge_1.5.0-green.svg
5454
:alt: Supported pytorch versions
5555

56-
.. |pip_python_versions| image:: ./images/pip_python-3.6_3.7_3.8-blue.svg
56+
.. |pip_python_versions| image:: ./images/python_ge_3.6-blue.svg
5757
:alt: Supported python versions
5858

59-
.. |pip_cuda_versions| image:: ./images/pip_cuda-10.1_10.2_11.0-orange.svg
59+
.. |pip_cuda_versions| image:: ./images/cuda_ge_10.1-orange.svg
6060
:alt: Supported cuda versions
6161

62-
.. |pip_pytorch_versions| image:: ./images/pip_pytorch-1.7.1-green.svg
62+
.. |pip_pytorch_versions| image:: ./images/pytorch_ge_1.5.0-green.svg
6363
:alt: Supported pytorch versions
6464

6565
.. |pypi_python_versions| image:: ./images/pypi_python-3.6_3.7_3.8-blue.svg
@@ -71,13 +71,13 @@ below:
7171
.. |pypi_pytorch_versions| image:: ./images/pypi_pytorch-1.7.1-green.svg
7272
:alt: Supported pytorch versions
7373

74-
.. |source_python_versions| image:: ./images/source_python-3.6_3.7_3.8_3.9-blue.svg
74+
.. |source_python_versions| image:: ./images/python_ge_3.6-blue.svg
7575
:alt: Supported python versions
7676

77-
.. |source_cuda_versions| image:: ./images/source_cuda-10.1_10.2_11.0_11.1_11.2_11.3-orange.svg
77+
.. |source_cuda_versions| image:: ./images/cuda_ge_10.1-orange.svg
7878
:alt: Supported cuda versions
7979

80-
.. |source_pytorch_versions| image:: ./images/source_pytorch-1.6.0_1.7.0_1.7.1_1.8.0_1.8.1-green.svg
80+
.. |source_pytorch_versions| image:: ./images/pytorch_ge_1.5.0-green.svg
8181
:alt: Supported pytorch versions
8282

8383
Reporting issues

docs/source/installation/pip.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Install using pip (k2-fsa.org)
22
==============================
33

4-
.. |pip_python_versions| image:: ./images/pip_python-3.6_3.7_3.8-blue.svg
4+
.. |pip_python_versions| image:: ./images/python_ge_3.6-blue.svg
55
:alt: Supported python versions
66

7-
.. |pip_cuda_versions| image:: ./images/pip_cuda-10.1_10.2_11.0-orange.svg
7+
.. |pip_cuda_versions| image:: ./images/cuda_ge_10.1-orange.svg
88
:alt: Supported cuda versions
99

10-
.. |pip_pytorch_versions| image:: ./images/pip_pytorch-1.7.1-green.svg
10+
.. |pip_pytorch_versions| image:: ./images/pytorch_ge_1.5.0-green.svg
1111
:alt: Supported pytorch versions
1212

1313
You can find a list of nightly pre-built

0 commit comments

Comments
 (0)