Skip to content

Commit 6fa2f8f

Browse files
committed
Update install guide
1 parent d3541e4 commit 6fa2f8f

File tree

1 file changed

+5
-29
lines changed

1 file changed

+5
-29
lines changed

docs/source/guide/install/install.md

Lines changed: 5 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,25 @@ EvoX is available at Pypi and can be installed via:
88
pip install evox
99
```
1010

11-
To install EvoX with optional dependencies:
12-
13-
```bash
14-
pip install evox[<feature1>,<feature2>]
15-
```
16-
17-
available features are `gymnasium`, `neuroevolution`, `envpool`, `distributed`, and `full` which concludes all features.
18-
For example, to install EvoX with all features, do:
19-
20-
```bash
21-
pip install evox[full]
22-
```
23-
2411
## Install JAX with accelerator support
2512

26-
`EvoX` relies on `JAX` to provide hardware acceleration.
13+
`EvoX` relies on `torch` to provide hardware acceleration.
2714
The overall architecture of these Python packages looks like this:
2815

2916
```{mermaid}
3017
stateDiagram-v2
31-
jaxlibCuda : jaxlib-cuda
18+
torch : torch
3219
gpu : NVIDIA GPU
3320
3421
direction LR
3522
36-
evox --> jax
37-
jax --> jaxlib
38-
jax --> jaxlibCuda
39-
jaxlib --> CPU
40-
jaxlibCuda --> gpu
23+
evox --> torch
24+
torch --> gpu
4125
```
4226

43-
`JAX` itself is pure Python, and `jaxlib` provides the C/C++ code.
44-
To utilize JAX's hardware acceleration ability, make sure to install the correct `jaxlib` version.
45-
4627
To summarize, you will need the follow 3 things to enable accelerator support:
4728
1. GPU driver
4829
2. CUDA libraries
49-
3. The correct jaxlib version (the one with accelerator support).
50-
51-
```{seealso}
52-
For more information, e.g. other platforms, please check out JAX's [official installation guide](https://github.com/google/jax/?tab=readme-ov-file#installation).
53-
```
5430

5531
### CPU only
5632

@@ -186,7 +162,7 @@ If you see something like this, then you are good to go.
186162
| 35% 35C P8 25W / 350W | 27MiB / 24576MiB | 0% Default |
187163
| | | N/A |
188164
+-----------------------------------------+----------------------+----------------------+
189-
165+
190166
+---------------------------------------------------------------------------------------+
191167
| Processes: |
192168
| GPU GI CI PID Type Process name GPU Memory |

0 commit comments

Comments
 (0)