From d2d379a6899eb90395022e9ad792b43e26700100 Mon Sep 17 00:00:00 2001 From: Chien-Chin Huang Date: Fri, 22 Nov 2024 15:18:52 -0800 Subject: [PATCH] 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. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 649728cc..6c494b59 100644 --- a/README.md +++ b/README.md @@ -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