Skip to content

Commit f1e0f12

Browse files
authored
some updates to the book (#977)
1 parent a0c78b7 commit f1e0f12

File tree

5 files changed

+20
-212
lines changed

5 files changed

+20
-212
lines changed

cubecl-book/src/SUMMARY.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,3 @@
1919
- [Struct](./language-support/struct.md)
2020
- [Advanced Usage](./advanced-usage/summary.md)
2121
- [Configuration](./advanced-usage/config.md)
22-
- [Algorithm reference](./algorithms/summary.md)
23-
- [Quantized matrix multiplication](./algorithms/quantized_matmul.md)
24-
- [Pseudo Random Number Generator]()

cubecl-book/src/algorithms/quantized_matmul.md

Lines changed: 0 additions & 189 deletions
This file was deleted.

cubecl-book/src/algorithms/summary.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

cubecl-book/src/core-features/features.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,5 +83,10 @@ Async tensor loading using the TMA accelerator available on Blackwell cards.
8383
Plane-level cooperative matrix multiply-add operations, with built-in block scaling. Available on
8484
Blackwell cards.
8585

86+
---
87+
8688
[^1]: fp8/fp6/fp4 types are supported only for conversion and MMA
89+
90+
<!-- -->
91+
8792
[^2]: bf16 is only supported for conversion, CMMA and, on some platforms, dot product
Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Installation
2-
Installing CubeCL is straightforward. It’s available as a Rust crate, and you can add it to your project by updating your Cargo.toml:
2+
3+
Installing CubeCL is straightforward. It’s available as a Rust crate, and you can add it to your
4+
project by updating your Cargo.toml:
35

46
```toml
57
[dependencies]
@@ -9,14 +11,17 @@ cubecl = {
911
}
1012
```
1113

12-
The more challenging aspect is ensuring that you have the necessary drivers to run the selected runtime.
14+
The more challenging aspect is ensuring that you have the necessary drivers to run the selected
15+
runtime.
1316

14-
CubeCL supports multiple GPU runtimes, each requiring specific drivers or frameworks. Enable the appropriate feature flag in Cargo.toml and ensure the corresponding drivers are installed.
17+
CubeCL supports multiple GPU and CPU runtimes, each requiring specific drivers or frameworks. Enable
18+
the appropriate feature flag in Cargo.toml and ensure the corresponding drivers are installed.
1519

16-
| Platform | Runtime | Supported OS | Requirements | Installation/Notes | Feature Flag |
17-
|----------|----------|-----------------------------|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|
18-
| WebGPU | wgpu | Linux, Windows, macOS, wasm | Vulkan drivers (typically pre-installed on modern OSes) | On linux install the vulkan driver. | wgpu |
19-
| CUDA | CUDA | Linux, Windows | NVIDIA CUDA drivers and toolkit | Download and install from the NVIDIA CUDA Downloads page. Verify installation with nvidia-smi. | cuda |
20-
| ROCm | HIP | Linux, Windows | AMD ROCm framework | Linux: Follow the ROCm Linux Quick Start. Windows: See the ROCm Windows Installation Guide. | hip |
21-
| Metal | wgpu | macOS | Apple device with Metal support (macOS 10.13 or later) | No additional drivers needed; Metal is built into macOS. | wgpu-msl |
22-
| Vulkan | wgpu | Linux, Windows | Vulkan drivers | On linux install via package manager, on windows it is typically included with GPU drivers (NVIDIA/AMD). | wgpu-spirv |
20+
| Platform | Device Type | Runtime | Supported OS | Requirements | Installation/Notes | Feature Flag |
21+
| -------- | ----------- | -------- | --------------------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------ |
22+
| WebGPU | GPU | wgpu | Linux, Windows, macOS, wasm | Vulkan drivers (typically pre-installed on modern OSes) | On linux install the vulkan driver. | wgpu |
23+
| CUDA | GPU | CUDA | Linux, Windows | NVIDIA CUDA drivers and toolkit | Download and install from the NVIDIA CUDA Downloads page. Verify installation with nvidia-smi. | cuda |
24+
| ROCm | GPU | HIP | Linux, Windows | AMD ROCm framework | Linux: Follow the ROCm Linux Quick Start. Windows: See the ROCm Windows Installation Guide. | hip |
25+
| Metal | GPU | wgpu | macOS | Apple device with Metal support (macOS 10.13 or later) | No additional drivers needed; Metal is built into macOS. | wgpu-msl |
26+
| Vulkan | GPU | wgpu | Linux, Windows | Vulkan drivers | On linux install via package manager, on windows it is typically included with GPU drivers (NVIDIA/AMD). | wgpu-spirv |
27+
| LLVM | CPU | Rust Std | LLVM supported targets | LLVM bundle | Automatically installed when compiling | cpu |

0 commit comments

Comments
 (0)