@moduledoc => @doc

cocoa-xu · Apr 2, 2023 · 29f44f6 · 29f44f6
1 parent d7ae916
commit 29f44f6
Show file tree

Hide file tree

Showing 11 changed files with 13 additions and 13 deletions.
diff --git a/src/tflite_beam.app.src b/src/tflite_beam.app.src
@@ -1,6 +1,6 @@
 {application, tflite_beam,
  [{description, "TensorFlow Lite BEAM binding with optional TPU support."},
-  {vsn, "0.2.1"},
+  {vsn, "0.3.0"},
   {registered, []},
   {applications,
    [kernel,

diff --git a/src/tflite_beam/tflite_beam_coral.erl b/src/tflite_beam/tflite_beam_coral.erl
@@ -1,4 +1,4 @@
-%% @moduledoc
+%% @doc
 %% This module contains libcoral C++ API, which provides
 %% convenient functions to perform inferencing and on-device transfer learning
 %% with TensorFlow Lite models on [Coral devices](https://coral.ai/products/).

diff --git a/src/tflite_beam/tflite_beam_error_reporter.erl b/src/tflite_beam/tflite_beam_error_reporter.erl
@@ -1,4 +1,4 @@
-%% @moduledoc
+%% @doc
 %% ErrorReporter to provide reporting destinations.
 
 -module(tflite_beam_error_reporter).

diff --git a/src/tflite_beam/tflite_beam_flatbuffer_model.erl b/src/tflite_beam/tflite_beam_flatbuffer_model.erl
@@ -1,4 +1,4 @@
-%% @moduledoc
+%% @doc
 %% An RAII object that represents a read-only tflite model, copied from disk, or
 %% mmapped.
 
@@ -67,7 +67,7 @@ build_from_file(Filename, Opts) when is_binary(Filename), is_list(Opts) ->
 %% ==== Positional Parameters ====
 %% @param Filename Path to the .tflite file.
 %%
-%% @return `invalid` in case of failure.
+%% @return `invalid' in case of failure.
 -spec verify_and_build_from_file(list() | binary()) -> #tflite_beam_flatbuffer_model{} | {error, binary()}.
 verify_and_build_from_file(Filename) when is_list(Filename) ->
     verify_and_build_from_file(unicode:characters_to_binary(Filename), []);
@@ -83,7 +83,7 @@ verify_and_build_from_file(Filename) when is_binary(Filename) ->
 %% ==== Keyword Parameters ====
 %% @param error_reporter Error reporter.
 %%
-%% @return `invalid` in case of failure.
+%% @return `invalid' in case of failure.
 -spec verify_and_build_from_file(list() | binary(), list()) -> #tflite_beam_flatbuffer_model{} | invalid | {error, binary()}.
 verify_and_build_from_file(Filename, Opts) when is_list(Filename), is_list(Opts) ->
     verify_and_build_from_file(unicode:characters_to_binary(Filename), Opts);

diff --git a/src/tflite_beam/tflite_beam_interpreter.erl b/src/tflite_beam/tflite_beam_interpreter.erl
@@ -1,4 +1,4 @@
-%% @moduledoc
+%% @doc
 %% An interpreter for a graph of nodes that input and output from tensors.
 
 -module(tflite_beam_interpreter).

diff --git a/src/tflite_beam/tflite_beam_interpreter_builder.erl b/src/tflite_beam/tflite_beam_interpreter_builder.erl
@@ -1,4 +1,4 @@
-%% @moduledoc
+%% @doc
 %% Build an interpreter capable of interpreting model.
 
 -module(tflite_beam_interpreter_builder).

diff --git a/src/tflite_beam/tflite_beam_ops_builtin_builtin_resolver.erl b/src/tflite_beam/tflite_beam_ops_builtin_builtin_resolver.erl
@@ -1,4 +1,4 @@
-%% @moduledoc
+%% @doc
 %% This built-in op resolver provides a list of TfLite delegates that could be
 %% applied by TfLite interpreter by default.
 

diff --git a/src/tflite_beam/tflite_beam_tensor.erl b/src/tflite_beam/tflite_beam_tensor.erl
@@ -1,4 +1,4 @@
-%% @moduledoc
+%% @doc
 %% A typed multi-dimensional array used in Tensorflow Lite.
 
 -module(tflite_beam_tensor).

diff --git a/src/tflite_beam/tokenizer/tflite_beam_basic_tokenizer.erl b/src/tflite_beam/tokenizer/tflite_beam_basic_tokenizer.erl
@@ -1,4 +1,4 @@
-%% @moduledoc
+%% @doc
 %% Runs basic tokenization such as punctuation spliting, lower casing.
 %%
 %% Related link: https://github.com/tensorflow/examples/blob/master/lite/examples/bert_qa/ios/BertQACore/Models/Tokenizers/BasicTokenizer.swift

diff --git a/src/tflite_beam/tokenizer/tflite_beam_full_tokenizer.erl b/src/tflite_beam/tokenizer/tflite_beam_full_tokenizer.erl
@@ -1,4 +1,4 @@
-%% @moduledoc
+%% @doc
 %% Runs end-to-end tokenization.
 %%
 %% Related link: https://github.com/tensorflow/examples/blob/master/lite/examples/bert_qa/ios/BertQACore/Models/Tokenizers/FullTokenizer.swift

diff --git a/src/tflite_beam/tokenizer/tflite_beam_wordpiece_tokenizer.erl b/src/tflite_beam/tokenizer/tflite_beam_wordpiece_tokenizer.erl
@@ -1,4 +1,4 @@
-%% @moduledoc
+%% @doc
 %% Runs WordPiece tokenziation.
 
 -module(tflite_beam_wordpiece_tokenizer).