From 016b6094810ce27cfe10d919c9cfa36042cb7d8d Mon Sep 17 00:00:00 2001 From: Mikko Juola Date: Sat, 18 Mar 2023 00:55:03 -0700 Subject: [PATCH] More install instructions. --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 645ba35..1513d54 100644 --- a/README.md +++ b/README.md @@ -35,9 +35,18 @@ PyTorch. Well almost, it doesn't unzip them automatically (see below). The implementation uses AVX2, even in the OpenCL codepath, so this will only run on AMD64 at this time. -# How to run +# Crates.io Cargo package install + +As of March 18, `rllama` is on `crates.io`. You can install it with `cargo install rllama`. You may need to explicitly enable AVX2 features: -As of March 18, `rllama` is on `crates.io`. You can install it with `cargo install rllama`. +``` +RUSTFLAGS="-C target-feature=+sse2,+avx,+fma,+avx2" cargo install rllama +``` + +There is a `.cargo/config.toml` inside this repository that will enable these +features if you install manually from this Git repository instead. + +# How to run You will need Rust. Make sure you can run `cargo` from a command line. In particular, this is using unstable features so you need nightly rust. Make sure