Skip to content

Commit d2d379a

Browse files
committed
Update README.md to include Rust installation
It is actually not as easy as I originally imagined. So it worths to add a section for future users.
1 parent ee864cf commit d2d379a

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,19 @@ greatly improve efficiency by avoiding stop the world training on errors.
3030

3131
## Installation
3232

33+
Before proceeding, ensure you have Rust installed on your system. Note that the Rust versions available in many conda environments may be outdated. To install the latest version of Rust, we recommend downloading it directly from the official website as shown in the below command:
34+
```sh
35+
$ curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh
36+
```
37+
3338
```sh
3439
$ pip install .
3540
```
3641

3742
This uses pyo3+maturin to build the package, you'll need maturin installed.
3843

44+
If the installation command fails to invoke `cargo update` due to an inability to fetch the manifest, it may be caused by the `proxy`, `proxySSLCert`, and `proxySSLKey` settings in your .`gitconfig` file affecting the `cargo` command. To resolve this issue, try temporarily removing these fields from your `.gitconfig` before running the installation command.
45+
3946
To install in editable mode w/ the Rust extensions you can use the normal pip install command:
4047

4148
```sh

0 commit comments

Comments
 (0)