Skip to content
This repository was archived by the owner on Apr 6, 2026. It is now read-only.

Commit f109972

Browse files
authored
feat: include cachix instructions in readme (#178)
This PR simply adds `cachix` instructions to the main readme and nix docs to help users get started with the cache for much faster builds
1 parent 99306a9 commit f109972

2 files changed

Lines changed: 26 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,17 @@ is updated for the final release.
2424

2525
## 🚀 Quick Start
2626

27-
We recommend using [Nix](https://nixos.org/download.html) to build kernels. Quick start a build with:
27+
We recommend using [Nix](https://nixos.org/download.html) to build kernels. To speed up builds, first enable the Hugging Face binary cache:
28+
29+
```bash
30+
# Install cachix and configure the cache
31+
cachix use huggingface
32+
33+
# Or run once without installing cachix
34+
nix run nixpkgs#cachix -- use huggingface
35+
```
36+
37+
Then quick start a build with:
2838

2939
```bash
3040
cd examples/activation

docs/nix.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,23 @@ and `flake.lock` to your repository, this will ensure that kernel
1919
builds are reproducible.
2020

2121
Since the kernel builder depends on many packages (e.g. every supported
22-
PyTorch version), it is recommended to [enable the huggingface cache](https://app.cachix.org/cache/huggingface)
22+
PyTorch version), it is recommended to enable the huggingface cache
2323
to avoid expensive rebuilds.
2424

25+
To use the cache, you can either install cachix and configure it:
26+
27+
```bash
28+
# Install cachix and configure the cache
29+
cachix use huggingface
30+
```
31+
32+
Or run it once without installing cachix permanently:
33+
34+
```bash
35+
# Use cachix without installing it
36+
nix run nixpkgs#cachix -- use huggingface
37+
```
38+
2539
The kernel builder also provides Nix development shells with all Torch
2640
and CUDA/ROCm dependencies needed to develop kernels (see below). If
2741
you want to test your kernels inside a Nix development shell and you

0 commit comments

Comments
 (0)