react-native-executorch 0.7.0-nightly-b4770df-20260205 → 0.7.1

package/common/rnexecutorch/ErrorCodes.h

@@ -9,33 +9,27 @@ namespace rnexecutorch {
 
 enum class RnExecutorchErrorCode : int32_t {
   /**
-   * An umbrella-error that is thrown usually when something unexpected happens,
-   * for example a 3rd-party library error.
+   * An umbrella-error that is thrown usually when something unexpected happens, for example a 3rd-party library error.
    */
   UnknownError = 101,
   /**
-   * Thrown when a user tries to run a model that is not yet downloaded or
-   * loaded into memory.
+   * Thrown when a user tries to run a model that is not yet downloaded or loaded into memory.
    */
   ModuleNotLoaded = 102,
   /**
-   * An error ocurred when saving a file. This could be, for instance a result
-   * image from an image model.
+   * An error ocurred when saving a file. This could be, for instance a result image from an image model.
    */
   FileWriteFailed = 103,
   /**
-   * Thrown when a user tries to run a model that is currently processing. It is
-   * only allowed to run a single model prediction at a time.
+   * Thrown when a user tries to run a model that is currently processing. It is only allowed to run a single model prediction at a time.
    */
   ModelGenerating = 104,
   /**
-   * Thrown when a language is passed to a multi-language model that is not
-   * supported. For example OCR or Speech To Text.
+   * Thrown when a language is passed to a multi-language model that is not supported. For example OCR or Speech To Text.
    */
   LanguageNotSupported = 105,
   /**
-   * Thrown when config parameters passed to a model are invalid. For example,
-   * when LLM's topp is outside of range [0, 1].
+   * Thrown when config parameters passed to a model are invalid. For example, when LLM's topp is outside of range [0, 1].
    */
   InvalidConfig = 112,
   /**
@@ -43,8 +37,7 @@ enum class RnExecutorchErrorCode : int32_t {
    */
   InvalidModelSource = 255,
   /**
-   * Thrown when the number of passed inputs to the model is different than the
-   * model metadata specifies.
+   * Thrown when the number of passed inputs to the model is different than the model metadata specifies.
    */
   UnexpectedNumInputs = 97,
   /**
@@ -52,8 +45,7 @@ enum class RnExecutorchErrorCode : int32_t {
    */
   ThreadPoolError = 113,
   /**
-   * Thrown when a file read operation failed. This could be invalid image url
-   * passed to image models, or unsupported format.
+   * Thrown when a file read operation failed. This could be invalid image url passed to image models, or unsupported format.
    */
   FileReadFailed = 114,
   /**
@@ -61,8 +53,7 @@ enum class RnExecutorchErrorCode : int32_t {
    */
   InvalidModelOutput = 115,
   /**
-   * Thrown when the dimensions of input tensors don't match the model's
-   * expected dimensions.
+   * Thrown when the dimensions of input tensors don't match the model's expected dimensions.
    */
   WrongDimensions = 116,
   /**
@@ -71,8 +62,7 @@ enum class RnExecutorchErrorCode : int32_t {
    */
   InvalidUserInput = 117,
   /**
-   * Thrown when the number of downloaded files is unexpected, due to download
-   * interruptions.
+   * Thrown when the number of downloaded files is unexpected, due to download interruptions.
    */
   DownloadInterrupted = 118,
   /**
@@ -85,23 +75,19 @@ enum class RnExecutorchErrorCode : int32_t {
    */
   MultilingualConfiguration = 160,
   /**
-   * Thrown when streaming transcription is attempted but audio data chunk is
-   * missing.
+   * Thrown when streaming transcription is attempted but audio data chunk is missing.
    */
   MissingDataChunk = 161,
   /**
-   * Thrown when trying to stop or insert data into a stream that hasn't been
-   * started.
+   * Thrown when trying to stop or insert data into a stream that hasn't been started.
    */
   StreamingNotStarted = 162,
   /**
-   * Thrown when trying to start a new streaming session while another is
-   * already in progress.
+   * Thrown when trying to start a new streaming session while another is already in progress.
    */
   StreamingInProgress = 163,
   /**
-   * Thrown when a resource fails to download. This could be due to invalid URL,
-   * or for example a network problem.
+   * Thrown when a resource fails to download. This could be due to invalid URL, or for example a network problem.
    */
   ResourceFetcherDownloadFailed = 180,
   /**
@@ -117,8 +103,7 @@ enum class RnExecutorchErrorCode : int32_t {
    */
   ResourceFetcherAlreadyOngoing = 183,
   /**
-   * Thrown when trying to pause, resume, or cancel a download that is not
-   * active.
+   * Thrown when trying to pause, resume, or cancel a download that is not active.
    */
   ResourceFetcherNotActive = 184,
   /**

package/common/rnexecutorch/TokenizerModule.cpp

@@ -13,8 +13,7 @@ using namespace executorch::extension::constants;
 
 TokenizerModule::TokenizerModule(
     std::string source, std::shared_ptr<react::CallInvoker> callInvoker)
-    : tokenizer(std::make_unique<tokenizers::HFTokenizer>()),
-      memorySizeLowerBound(std::filesystem::file_size(source)) {
+    : tokenizer(std::make_unique<tokenizers::HFTokenizer>()) {
 
   auto status = tokenizer->load(source);
 
@@ -22,6 +21,8 @@ TokenizerModule::TokenizerModule(
     throw RnExecutorchError(RnExecutorchErrorCode::TokenizerError,
                             "Unexpected issue occured while loading tokenizer");
   };
+  std::filesystem::path modelPath{source};
+  memorySizeLowerBound = std::filesystem::file_size(modelPath);
 }
 
 void TokenizerModule::ensureTokenizerLoaded(

package/common/rnexecutorch/TokenizerModule.h

@@ -26,7 +26,7 @@ public:
 private:
   void ensureTokenizerLoaded(const std::string &methodName) const;
   std::unique_ptr<tokenizers::HFTokenizer> tokenizer;
-  const std::size_t memorySizeLowerBound{0};
+  std::size_t memorySizeLowerBound{0};
 };
 
 REGISTER_CONSTRUCTOR(TokenizerModule, std::string,

package/common/rnexecutorch/host_objects/ModelHostObject.h

@@ -107,6 +107,11 @@ public:
           synchronousHostFunction<&Model::getGeneratedTokenCount>,
           "getGeneratedTokenCount"));
 
+      addFunctions(JSI_EXPORT_FUNCTION(
+          ModelHostObject<Model>,
+          synchronousHostFunction<&Model::getPromptTokenCount>,
+          "getPromptTokenCount"));
+
       addFunctions(
           JSI_EXPORT_FUNCTION(ModelHostObject<Model>,
                               synchronousHostFunction<&Model::setCountInterval>,

package/common/rnexecutorch/models/llm/LLM.cpp

@@ -71,6 +71,13 @@ size_t LLM::getGeneratedTokenCount() const noexcept {
   return runner->stats_.num_generated_tokens;
 }
 
+size_t LLM::getPromptTokenCount() const noexcept {
+  if (!runner || !runner->is_loaded()) {
+    return 0;
+  }
+  return runner->stats_.num_prompt_tokens;
+}
+
 size_t LLM::getMemoryLowerBound() const noexcept {
   return memorySizeLowerBound;
 }

package/common/rnexecutorch/models/llm/LLM.h

@@ -23,6 +23,7 @@ public:
   void interrupt();
   void unload() noexcept;
   size_t getGeneratedTokenCount() const noexcept;
+  size_t getPromptTokenCount() const noexcept;
   size_t getMemoryLowerBound() const noexcept;
   void setCountInterval(size_t countInterval);
   void setTemperature(float temperature);

package/lib/module/constants/llmDefaults.js

@@ -1,6 +1,19 @@
 "use strict";
 
+/**
+ * Default system prompt used to guide the behavior of Large Language Models (LLMs).
+ *
+ * @category Utilities - LLM
+ */
 export const DEFAULT_SYSTEM_PROMPT = "You are a knowledgeable, efficient, and direct AI assistant. Provide concise answers, focusing on the key information needed. Offer suggestions tactfully when appropriate to improve outcomes. Engage in productive collaboration with the user. Don't return too much text.";
+
+/**
+ * Generates a default structured output prompt based on the provided JSON schema.
+ *
+ * @category Utilities - LLM
+ * @param structuredOutputSchema - A string representing the JSON schema for the desired output format.
+ * @returns A prompt string instructing the model to format its output according to the given schema.
+ */
 export const DEFAULT_STRUCTURED_OUTPUT_PROMPT = structuredOutputSchema => `The output should be formatted as a JSON instance that conforms to the JSON schema below.
 
 As an example, for the schema {"properties": {"foo": {"title": "Foo", "description": "a list of strings", "type": "array", "items": {"type": "string"}}}, "required": ["foo"]}
@@ -9,8 +22,26 @@ the object {"foo": ["bar", "baz"]} is a well-formatted instance of the schema. T
 Here is the output schema:
 ${structuredOutputSchema}
 `;
+
+/**
+ * Default message history for Large Language Models (LLMs).
+ *
+ * @category Utilities - LLM
+ */
 export const DEFAULT_MESSAGE_HISTORY = [];
+
+/**
+ * Default context window length for Large Language Models (LLMs).
+ *
+ * @category Utilities - LLM
+ */
 export const DEFAULT_CONTEXT_WINDOW_LENGTH = 5;
+
+/**
+ * Default chat configuration for Large Language Models (LLMs).
+ *
+ * @category Utilities - LLM
+ */
 export const DEFAULT_CHAT_CONFIG = {
   systemPrompt: DEFAULT_SYSTEM_PROMPT,
   initialMessageHistory: DEFAULT_MESSAGE_HISTORY,

package/lib/module/constants/llmDefaults.js.map

@@ -1 +1 @@
-{"version":3,"names":["DEFAULT_SYSTEM_PROMPT","DEFAULT_STRUCTURED_OUTPUT_PROMPT","structuredOutputSchema","DEFAULT_MESSAGE_HISTORY","DEFAULT_CONTEXT_WINDOW_LENGTH","DEFAULT_CHAT_CONFIG","systemPrompt","initialMessageHistory","contextWindowLength"],"sourceRoot":"../../../src","sources":["constants/llmDefaults.ts"],"mappings":";;AAEA,OAAO,MAAMA,qBAAqB,GAChC,+QAA+Q;AAEjR,OAAO,MAAMC,gCAAgC,GAC3CC,sBAA8B,IAC3B;AACL;AACA;AACA;AACA;AACA;AACA,EAAEA,sBAAsB;AACxB,CAAC;AAED,OAAO,MAAMC,uBAAkC,GAAG,EAAE;AAEpD,OAAO,MAAMC,6BAA6B,GAAG,CAAC;AAE9C,OAAO,MAAMC,mBAA+B,GAAG;EAC7CC,YAAY,EAAEN,qBAAqB;EACnCO,qBAAqB,EAAEJ,uBAAuB;EAC9CK,mBAAmB,EAAEJ;AACvB,CAAC","ignoreList":[]}
+{"version":3,"names":["DEFAULT_SYSTEM_PROMPT","DEFAULT_STRUCTURED_OUTPUT_PROMPT","structuredOutputSchema","DEFAULT_MESSAGE_HISTORY","DEFAULT_CONTEXT_WINDOW_LENGTH","DEFAULT_CHAT_CONFIG","systemPrompt","initialMessageHistory","contextWindowLength"],"sourceRoot":"../../../src","sources":["constants/llmDefaults.ts"],"mappings":";;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMA,qBAAqB,GAChC,+QAA+Q;;AAEjR;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,gCAAgC,GAC3CC,sBAA8B,IAC3B;AACL;AACA;AACA;AACA;AACA;AACA,EAAEA,sBAAsB;AACxB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,uBAAkC,GAAG,EAAE;;AAEpD;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,6BAA6B,GAAG,CAAC;;AAE9C;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,mBAA+B,GAAG;EAC7CC,YAAY,EAAEN,qBAAqB;EACnCO,qBAAqB,EAAEJ,uBAAuB;EAC9CK,mBAAmB,EAAEJ;AACvB,CAAC","ignoreList":[]}