Skip to content

Commit 1a1da24

Browse files
authored
Merge pull request #204 from ausimian/docs/bump-to-1.0
docs: bump install requirement to ~> 1.0 (and fix FastKernels moduledoc drift)
2 parents d3e9a10 + f7432b1 commit 1a1da24

10 files changed

Lines changed: 20 additions & 18 deletions

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Add `:emily` to your `mix.exs` deps:
2929
```elixir
3030
def deps do
3131
[
32-
{:emily, "~> 0.7"}
32+
{:emily, "~> 1.0"}
3333
]
3434
end
3535
```
@@ -65,9 +65,11 @@ Emily backend smoke test.
6565
other backends.
6666
- **Affine group-wise quantization.** `Emily.QuantizedWeight` +
6767
`Emily.Quantization` wrap MLX `quantize` / `dequantize` /
68-
`quantized_matmul` for int2 / int4 / int8 inference. Includes a
69-
defn-native `dequantize_defn/1` for quantized layers inside Axon
70-
forward passes.
68+
`quantized_matmul` for int2 / int4 / int8 inference. Quantized dense
69+
layers lower to the fused `quantized_matmul` kernel — streaming the
70+
packed low-bit weights instead of dequantizing the whole weight per
71+
token — with a `dequantize_defn/1` + `Nx.dot` fallback on non-MLX
72+
backends.
7173
- **Mixed-precision training.** `Emily.MixedPrecision` provides the
7274
bf16 recipe (cast params for the forward, keep f32 master, dynamic
7375
loss scaling with overflow detection).
@@ -99,7 +101,7 @@ Releases on first `mix compile`.
99101

100102
### As a hex consumer
101103

102-
Add `{:emily, "~> 0.7"}` to `mix.exs`, then:
104+
Add `{:emily, "~> 1.0"}` to `mix.exs`, then:
103105

104106
```sh
105107
mix deps.get

lib/emily/bumblebee/fast_kernels.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ if Code.ensure_loaded?(Axon) and Code.ensure_loaded?(Bumblebee.Layers) do
2424
entirely when either dep is missing. To use the shim, add both to
2525
your own `deps/0`:
2626
27-
{:bumblebee, "~> 0.6"},
28-
{:axon, "~> 0.7"}
27+
{:bumblebee, "~> 0.7"},
28+
{:axon, "~> 0.8"}
2929
3030
## Usage
3131

livebooks/distilbert_qa.livemd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
```elixir
44
Mix.install(
55
[
6-
{:emily, "~> 0.7"},
6+
{:emily, "~> 1.0"},
77
{:bumblebee, "~> 0.7"},
88
{:tokenizers, "~> 0.5"},
99
{:nx, "~> 0.12"},

livebooks/fast_kernels.livemd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
```elixir
44
Mix.install(
55
[
6-
{:emily, "~> 0.7"},
6+
{:emily, "~> 1.0"},
77
{:bumblebee, "~> 0.7"},
88
{:tokenizers, "~> 0.5"},
99
{:axon, "~> 0.8"},

livebooks/mnist_training.livemd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
```elixir
44
Mix.install(
55
[
6-
{:emily, "~> 0.7"},
6+
{:emily, "~> 1.0"},
77
{:axon, "~> 0.8"},
88
{:scidata, "~> 0.1"},
99
{:nx, "~> 0.12"},

livebooks/modernbert_classification.livemd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
```elixir
44
Mix.install(
55
[
6-
{:emily, "~> 0.7"},
6+
{:emily, "~> 1.0"},
77
{:bumblebee, "~> 0.7"},
88
{:tokenizers, "~> 0.5"},
99
{:nx, "~> 0.12"},

livebooks/nomic_embeddings.livemd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
```elixir
44
Mix.install(
55
[
6-
{:emily, "~> 0.7"},
6+
{:emily, "~> 1.0"},
77
{:bumblebee, "~> 0.7"},
88
{:tokenizers, "~> 0.5"},
99
{:nx, "~> 0.12"},

livebooks/qwen3_quantized.livemd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
```elixir
44
Mix.install(
55
[
6-
{:emily, "~> 0.7"},
6+
{:emily, "~> 1.0"},
77
{:bumblebee, "~> 0.7"},
88
{:tokenizers, "~> 0.5"},
99
{:nx, "~> 0.12"},
@@ -57,7 +57,7 @@ dense_text
5757
`native: true, native_fallback: :raise` on `:defn_options` lowers the
5858
per-token decode through Emily's native Expr compiler and asserts it
5959
stays fully native — the quantized serving below passes the same
60-
options, so the int4 dequantize path lowers native too.
60+
options, so the int4 quantized matmul lowers native too.
6161

6262
## Quantization transform
6363

@@ -168,8 +168,8 @@ end
168168
> recursive rewriter. The `transpose: true` default stores weights as
169169
> `[out, in]` (MLX / AWQ convention, groups along the reduction axis);
170170
> set `false` if you're feeding a checkpoint that's already laid out
171-
> the other way. Bits must be one of `[2, 3, 4, 6, 8]` for the
172-
> defn-native `dequantize_defn/1` path.
171+
> the other way. Bits must be one of `[2, 3, 4, 6, 8]` for MLX affine
172+
> quantization.
173173
174174
## Quantized inference
175175

livebooks/smollm3_chat.livemd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
```elixir
44
Mix.install(
55
[
6-
{:emily, "~> 0.7"},
6+
{:emily, "~> 1.0"},
77
{:bumblebee, "~> 0.7"},
88
{:tokenizers, "~> 0.5"},
99
{:nx, "~> 0.12"},

livebooks/whisper_transcription.livemd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
```elixir
44
Mix.install(
55
[
6-
{:emily, "~> 0.7"},
6+
{:emily, "~> 1.0"},
77
{:bumblebee, "~> 0.7"},
88
{:tokenizers, "~> 0.5"},
99
{:nx, "~> 0.12"},

0 commit comments

Comments
 (0)