Improve docs for quantized types

elixir-nx · Sep 26, 2024 · 3df4fd5 · 3df4fd5
1 parent 633db2f
commit 3df4fd5
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/nx/README.md b/nx/README.md
@@ -4,7 +4,7 @@
 
 Nx is a multi-dimensional tensors library for Elixir with multi-staged compilation to the CPU/GPU. Its high-level features are:
 
-  * Typed multi-dimensional tensors, where the tensors can be unsigned integers (`u2`, `u4`, `u8`, `u16`, `u32`, `u64`), signed integers (`s2`, `s4`, `s8`, `s16`, `s32`, `s64`), floats (`f16`, `f32`, `f64`), brain floats (`bf16`), and complex numbers (`c64`, `c128`);
+  * Typed multi-dimensional tensors, where the tensors can be unsigned integers (`u2`, `u4`, `u8`, `u16`, `u32`, `u64`), signed integers (`s2`, `s4`, `s8`, `s16`, `s32`, `s64`), floats (`f8`, `f16`, `f32`, `f64`), brain floats (`bf16`), and complex numbers (`c64`, `c128`);
 
   * Named tensors, allowing developers to give names to each dimension, leading to more readable and less error prone codebases;
 

diff --git a/nx/lib/nx/type.ex b/nx/lib/nx/type.ex
@@ -5,8 +5,8 @@ defmodule Nx.Type do
   A type is a two-element tuple with the name and the size.
   The respective sizes for the types are the following:
 
-    * `:s` - signed integer (8, 16, 32, 64)
-    * `:u` - unsigned integer (8, 16, 32, 64)
+    * `:s` - signed integer (2, 4, 8, 16, 32, 64)
+    * `:u` - unsigned integer (2, 4, 8, 16, 32, 64)
     * `:f` - float (8, 16, 32, 64)
     * `:bf` - a brain floating point (16)
     * `:c` - a complex number, represented as a pair of floats (64, 128)