huggingface/candle
1
0
Fork 0
mirror of https://github.com/huggingface/candle.git synced 2025-06-16 10:38:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

improve

Browse Source
This commit is contained in:
Patrick von Platen
2023-08-23 08:37:08 +00:00
parent 65e146c72d
commit d4968295a0
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -12,9 +12,9 @@ and ease of use. Try our online demos:
## Installation ## Installation
- *With Cuda support*: - **With Cuda support**:
1. To install candle with Cuda support, first make sure that Cuda is correctly installed. 1. First, make sure that Cuda is correctly installed.
- `nvcc --version` should print your information about your Cuda compiler driver. - `nvcc --version` should print your information about your Cuda compiler driver.
- `nvidia-smi --query-gpu=compute_cap --format=csv` should print your GPUs compute capability, e.g. something - `nvidia-smi --query-gpu=compute_cap --format=csv` should print your GPUs compute capability, e.g. something
like: like:
@ -23,30 +23,30 @@ compute_cap
8.9 8.9
``` ```
If any of the above commands errors out, please make sure to update your CUDA version. If any of the above commands errors out, please make sure to update your Cuda version.
2. Create a new app and add [`candle-core`](https://github.com/huggingface/candle/tree/main/candle-core) with Cuda support 2. Create a new app and add [`candle-core`](https://github.com/huggingface/candle/tree/main/candle-core) with Cuda support
Start by creating a new cargo:
```bash ```bash
cargo new myapp cargo new myapp
cd myapp cd myapp
``` ```
Next make sure to add the `candle-core` crate with the cuda feature: Make sure to add the `candle-core` crate with the cuda feature:
``` ```
cargo add --git https://github.com/huggingface/candle.git candle-core --features "cuda" cargo add --git https://github.com/huggingface/candle.git candle-core --features "cuda"
``` ```
Finally, run `cargo build` to make sure everything can be correctly built. Run `cargo build` to make sure everything can be correctly built.
``` ```
cargo run cargo run
``` ```
Now you can run the example as shown in the next section! **Without Cuda support**:
- *Without Cuda support*:
Create a new app and add [`candle-core`](https://github.com/huggingface/candle/tree/main/candle-core) as follows: Create a new app and add [`candle-core`](https://github.com/huggingface/candle/tree/main/candle-core) as follows:
@ -56,7 +56,7 @@ cd myapp
cargo add --git https://github.com/huggingface/candle.git candle-core cargo add --git https://github.com/huggingface/candle.git candle-core
``` ```
Finally, run `cargo build` to make sure everything can be correctly built. Run `cargo build` to make sure everything can be correctly built.
``` ```
cargo run cargo run
@ -67,7 +67,8 @@ cargo run
Having installed `candle-core` as described in [Installation](#Installation), we can now Having installed `candle-core` as described in [Installation](#Installation), we can now
run a simple matrix multiplication. run a simple matrix multiplication.
First, let's add the [`anyhow`](https://docs.rs/anyhow/latest/anyhow/) package to our app. We will need the [`anyhow`](https://docs.rs/anyhow/latest/anyhow/) package for our example,
so let's add it to our app.
``` ```
cd myapp cd myapp