Skip to content

Commit 6c36794

Browse files
authored
Update installation instruction (brainpy#651)
* update * update installation docs
1 parent 165b9ee commit 6c36794

File tree

3 files changed

+30
-6
lines changed

3 files changed

+30
-6
lines changed

brainpylib-changelog.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,20 @@
22

33
## Version 0.3.0
44

5+
- Support `brainpy>=2.5.0`
56
- Fix bugs on windows platform
67
- remove all customized C++ and CUDA operators
78

8-
99
## Version 0.2.8
1010

11+
- Support `brainpy>=2.5.0`
1112
- Fix bugs that the DLL cannot be loaded correctly when windows does not have a c++ environment,
1213

1314
## ~~Version 0.2.7(YANKED)~~
1415

1516
## Version 0.2.6
1617

18+
- Support `brainpy>=2.5.0`
1719
- Fix bugs of taichi call function for single result
1820

1921
## Version 0.2.5

docs/index.rst

+11-3
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,24 @@ Installation
1919
2020
pip install -U brainpy[cpu] # windows, linux, macos
2121
22-
.. tab-item:: GPU (CUDA)
22+
.. tab-item:: GPU (CUDA 11.0)
2323

2424
.. code-block:: bash
2525
26-
# for CUDA 11.0, Linux only
2726
pip install -U brainpy[cuda11] -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
2827
29-
# for CUDA 12.0, Linux only
28+
.. tab-item:: GPU (CUDA 12.0)
29+
30+
.. code-block:: bash
31+
3032
pip install -U brainpy[cuda12] -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
3133
34+
.. tab-item:: TPU
35+
36+
.. code-block:: bash
37+
38+
pip install -U brainpy[tpu] -f https://storage.googleapis.com/jax-releases/libtpu_releases.html
39+
3240
3341
For more information, please see `installation <quickstart/installation.html>`_ section.
3442

docs/quickstart/installation.rst

+16-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ To install brainpy with minimum requirements (has installed ``jax`` and ``jaxlib
1717

1818
.. code-block:: bash
1919
20-
pip install brainpy # for CPU
21-
20+
pip install brainpy
2221
2322
2423
Minimum requirements (with dependencies)
@@ -35,6 +34,9 @@ To install brainpy with minimum requirements (only depends on ``jax``), you can
3534
pip install brainpy[cuda11_mini] -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html # for CUDA 11.0
3635
pip install brainpy[cuda12_mini] -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html # for CUDA 12.0
3736
37+
# or
38+
39+
pip install brainpy[tpu] -f https://storage.googleapis.com/jax-releases/libtpu_releases.html # for google TPU
3840
3941
4042
CPU with all dependencies
@@ -61,6 +63,18 @@ To install a GPU-only version of BrainPy, you can run
6163
6264
6365
66+
TPU with all dependencies
67+
-------------------------
68+
69+
BrainPy supports Google Cloud TPU. To install BrainPy along with appropriate versions of jax,
70+
you can run the following in your cloud TPU VM:
71+
72+
.. code-block:: bash
73+
74+
pip install brainpy[tpu] -f https://storage.googleapis.com/jax-releases/libtpu_releases.html # for google TPU
75+
76+
77+
6478
``brainpylib``
6579
--------------
6680

0 commit comments

Comments
 (0)