Improve code readability

software-mansion-labs · Jun 20, 2024 · 375ffb6 · 375ffb6
1 parent df4ff4b
commit 375ffb6
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/lib/ex_vision/classification/generic_classifier.ex b/lib/ex_vision/classification/generic_classifier.ex
@@ -1,6 +1,16 @@
 defmodule ExVision.Classification.GenericClassifier do
+  @moduledoc false
+
+  # Contains a default implementation of post processing for TorchVision classifiers
+  # To use: `use ExVision.Classification.GenericClassifier`
+
   alias ExVision.Utils
 
+  alias ExVision.Types.ImageMetadata
+
+  @typep output_t() :: %{atom() => number()}
+
+  @spec postprocessing(map(), ImageMetadata.t(), [atom()]) :: output_t()
   def postprocessing(%{"output" => scores}, _metadata, categories) do
     scores
     |> Nx.backend_transfer()