huggingface / huggingface/candle

The fact that Candle supports Metal is not mentioned in the mdbook (installation)

Open Beginner friendly
#3,497 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
21k
Forks
1.8k
Avg merge
16h 42m
Merged PRs (30d)
25

Description

README of this repo directs me to this page to install Candle:
https://huggingface.github.io/candle/guide/installation.html
However, the fact that Candle supports Metal is not mentioned in that page. It's only mentioned:
```
cargo add --git https://github.com/huggingface/candle.git candle-core --features "cuda"
```
So I suggest that the following should be added:
```
cargo add --git https://github.com/huggingface/candle.git candle-core --features "metal"
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Open the installation page linked from the repository README and compare its existing CUDA example with the requested Metal installation command. Update the installation documentation to mention Candle's Metal support and show the command, then verify the rendered mdbook page contains the new example.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.