Document dimension names of the Nx tensor. Bump version to 0.8.1

elixir-webrtc · Dec 30, 2024 · e515ec8 · e515ec8
1 parent 5f131b0
commit e515ec8
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ Make sure you have installed FFMpeg (ver. 4.x - 7.x) development packages on you
 ```elixir
 def deps do
   [
-    {:xav, "~> 0.8.0"},
+    {:xav, "~> 0.8.1"},
     # Add Nx if you want to have Xav.Frame.to_nx/1
     {:nx, ">= 0.0.0"}
   ]

diff --git a/lib/frame.ex b/lib/frame.ex
@@ -66,6 +66,8 @@ defmodule Xav.Frame do
   if Code.ensure_loaded?(Nx) do
     @doc """
     Converts a frame to an Nx tensor.
+
+    In case of a video frame, dimension names of the newly created tensor are `[:height, :width, :channels]`.
     """
     @spec to_nx(t()) :: Nx.Tensor.t()
     def to_nx(%__MODULE__{type: :video} = frame) do

diff --git a/mix.exs b/mix.exs
@@ -1,7 +1,7 @@
 defmodule Xav.MixProject do
   use Mix.Project
 
-  @version "0.8.0"
+  @version "0.8.1"
   @source_url "https://github.com/elixir-webrtc/xav"
 
   def project do