added typedoc

software-mansion-labs · Aug 20, 2024 · 4e92631 · 4e92631
1 parent 2b9c03a
commit 4e92631
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/ex_vision/style_transfer/style_transfer.ex b/lib/ex_vision/style_transfer/style_transfer.ex
@@ -23,6 +23,10 @@ for {module, opts} <- Configuration.configuration() do
     #{module} is a custom style transfer model optimised for devices with low computational capabilities and CPU inference.
     """
     require Logger
+
+    @typedoc """
+    A type consisting of output tesnor (stylized image tensor) from style transfer models of shape {#{Enum.join(Tuple.to_list(opts[:resolution]) ++ [3], ", ")}}.
+    """
     @type output_t() :: Nx.Tensor.t()
 
     use ExVision.Model.Definition.Ortex, model: unquote(opts[:model])