Skip to content

Commit 7195cb5

Browse files
authored
add a pinning note. (#604)
1 parent e7f2d30 commit 7195cb5

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

docs/source/installation.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# Installation
22

3+
> [!WARNING]
4+
> `kernels` has not reached `1.0` yet. Until then, minor releases may contain
5+
> breaking changes. If you depend on `kernels` in a library or application, we
6+
> **strongly recommend pinning a version range** rather than an unbounded
7+
> dependency. For example, in `pyproject.toml`:
8+
>
9+
> ```toml
10+
> dependencies = [
11+
> "kernels>=0.15,<0.16",
12+
> ]
13+
> ```
14+
>
15+
> or equivalently `kernels~=0.15` (compatible release). This protects your
16+
> project from unexpected breakage when a new `kernels` version is released.
17+
318
Install the `kernels` package with `pip` (requires `torch>=2.5` and CUDA):
419
520
```bash

0 commit comments

Comments
 (0)