Skip to content

Commit

Permalink
Update README.md to include Rust installation (#15)
Browse files Browse the repository at this point in the history
It is actually not as easy as I originally imagined. So it worths to add a section for future users.
  • Loading branch information
fegin authored Nov 22, 2024
1 parent ee864cf commit 829d26c
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,19 @@ greatly improve efficiency by avoiding stop the world training on errors.

## Installation

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:
```sh
$ curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh
```

```sh
$ pip install .
```

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

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.

To install in editable mode w/ the Rust extensions you can use the normal pip install command:

```sh
Expand Down

0 comments on commit 829d26c

Please sign in to comment.