cactus-react-native 0.2.11 → 1.0.2

package/src/native/index.ts

@@ -0,0 +1,5 @@
+export { Cactus } from './Cactus';
+export { CactusCrypto } from './CactusCrypto';
+export { CactusDeviceInfo } from './CactusDeviceInfo';
+export { CactusFileSystem } from './CactusFileSystem';
+export { CactusUtil } from './CactusUtil';

package/src/specs/Cactus.nitro.ts

@@ -0,0 +1,20 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+
+export interface Cactus extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
+  init(
+    modelPath: string,
+    contextSize: number,
+    corpusDir?: string
+  ): Promise<void>;
+  complete(
+    messagesJson: string,
+    responseBufferSize: number,
+    optionsJson?: string,
+    toolsJson?: string,
+    callback?: (token: string, tokenId: number) => void
+  ): Promise<string>;
+  embed(text: string, embeddingBufferSize: number): Promise<number[]>;
+  reset(): Promise<void>;
+  stop(): Promise<void>;
+  destroy(): Promise<void>;
+}

package/src/specs/CactusCrypto.nitro.ts

@@ -0,0 +1,6 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+
+export interface CactusCrypto
+  extends HybridObject<{ ios: 'swift'; android: 'kotlin' }> {
+  uuidv5(namespaceUuid: string, name: string): Promise<string>;
+}

package/src/specs/CactusDeviceInfo.nitro.ts

@@ -0,0 +1,15 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+
+export interface DeviceInfo {
+  brand: string;
+  model: string;
+  device_id?: string;
+  os: string;
+  os_version: string;
+}
+
+export interface CactusDeviceInfo
+  extends HybridObject<{ ios: 'swift'; android: 'kotlin' }> {
+  getAppIdentifier(): Promise<string | undefined>;
+  getDeviceInfo(): Promise<DeviceInfo>;
+}

package/src/specs/CactusFileSystem.nitro.ts

@@ -0,0 +1,21 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+
+export interface CactusFileSystem
+  extends HybridObject<{ ios: 'swift'; android: 'kotlin' }> {
+  // General
+  getCactusDirectory(): Promise<string>;
+  // File
+  fileExists(path: string): Promise<boolean>;
+  writeFile(path: string, content: string): Promise<void>;
+  readFile(path: string): Promise<string>;
+  deleteFile(path: string): Promise<void>;
+  // Model
+  modelExists(model: string): Promise<boolean>;
+  getModelPath(model: string): Promise<string>;
+  downloadModel(
+    model: string,
+    from: string,
+    callback?: (progress: number) => void
+  ): Promise<void>;
+  deleteModel(model: string): Promise<void>;
+}

package/src/specs/CactusUtil.nitro.ts

@@ -0,0 +1,8 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+
+export interface CactusUtil
+  extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
+  registerApp(encryptedData: string): Promise<string>;
+  getDeviceId(): Promise<string | null>;
+  setAndroidDataDirectory(dataDir: string): Promise<void>;
+}

package/src/telemetry/Telemetry.ts

@@ -0,0 +1,159 @@
+import { Database } from '../api/Database';
+import {
+  CactusCrypto,
+  CactusDeviceInfo,
+  CactusFileSystem,
+  CactusUtil,
+} from '../native';
+import { CactusConfig } from '../config/CactusConfig';
+import { packageVersion } from '../constants/packageVersion';
+import type { CactusLMCompleteResult } from '../types/CactusLM';
+
+export interface LogRecord {
+  // Framework
+  framework: 'react-native';
+  framework_version: string;
+
+  // Event
+  event_type: 'init' | 'completion' | 'embedding';
+  model: string;
+  success: boolean;
+  message?: string;
+
+  // Telemetry
+  telemetry_token?: string;
+  project_id?: string;
+  device_id?: string;
+
+  // LM
+  tokens?: number;
+  response_time?: number;
+  ttft?: number;
+  tps?: number;
+}
+
+export class Telemetry {
+  private static cactusTelemetryToken?: string;
+  private static projectId?: string;
+  private static deviceId?: string;
+
+  private static readonly namespaceUrl = '6ba7b811-9dad-11d1-80b4-00c04fd430c8';
+  private static readonly logBufferPaths = {
+    init: 'logs/init.json',
+    completion: 'logs/completion.json',
+    embedding: 'logs/embedding.json',
+  };
+
+  private static async handleLog(logRecord: LogRecord) {
+    if (!CactusConfig.isTelemetryEnabled) {
+      return;
+    }
+
+    const logBufferPath = this.logBufferPaths[logRecord.event_type];
+
+    let logs = [];
+    if (await CactusFileSystem.fileExists(logBufferPath)) {
+      try {
+        logs = JSON.parse(await CactusFileSystem.readFile(logBufferPath));
+      } catch {
+        // Delete corrupted log buffer
+        await CactusFileSystem.deleteFile(logBufferPath);
+      }
+    }
+    logs.push(logRecord);
+
+    try {
+      await Database.sendLogRecords(logs);
+
+      if (await CactusFileSystem.fileExists(logBufferPath)) {
+        await CactusFileSystem.deleteFile(logBufferPath);
+      }
+    } catch {
+      await CactusFileSystem.writeFile(logBufferPath, JSON.stringify(logs));
+    }
+  }
+
+  public static isInitialized(): boolean {
+    return !!(this.projectId && this.deviceId);
+  }
+
+  public static async init(cactusTelemetryToken?: string): Promise<void> {
+    if (!CactusConfig.isTelemetryEnabled) {
+      return;
+    }
+
+    this.cactusTelemetryToken = cactusTelemetryToken;
+
+    const appIdentifier = await CactusDeviceInfo.getAppIdentifier();
+    const name = `https://cactus-react-native/${appIdentifier}/v1`;
+    this.projectId = await CactusCrypto.uuidv5(this.namespaceUrl, name);
+
+    const deviceInfo = await CactusDeviceInfo.getDeviceInfo();
+    try {
+      this.deviceId =
+        (await CactusUtil.getDeviceId()) ??
+        (await Database.registerDevice(deviceInfo));
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
+  public static logInit(
+    model: string,
+    success: boolean,
+    message?: string
+  ): Promise<void> {
+    return this.handleLog({
+      framework: 'react-native',
+      framework_version: packageVersion,
+      event_type: 'init',
+      model,
+      success,
+      message,
+      telemetry_token: this.cactusTelemetryToken,
+      project_id: this.projectId,
+      device_id: this.deviceId,
+    });
+  }
+
+  public static logCompletion(
+    model: string,
+    success: boolean,
+    message?: string,
+    result?: CactusLMCompleteResult
+  ): Promise<void> {
+    return this.handleLog({
+      framework: 'react-native',
+      framework_version: packageVersion,
+      event_type: 'completion',
+      model,
+      success,
+      message,
+      telemetry_token: this.cactusTelemetryToken,
+      project_id: this.projectId,
+      device_id: this.deviceId,
+      tokens: result?.totalTokens,
+      response_time: result?.totalTimeMs,
+      ttft: result?.timeToFirstTokenMs,
+      tps: result?.tokensPerSecond,
+    });
+  }
+
+  public static logEmbedding(
+    model: string,
+    success: boolean,
+    message?: string
+  ): Promise<void> {
+    return this.handleLog({
+      framework: 'react-native',
+      framework_version: packageVersion,
+      event_type: 'embedding',
+      model,
+      success,
+      message,
+      telemetry_token: this.cactusTelemetryToken,
+      project_id: this.projectId,
+      device_id: this.deviceId,
+    });
+  }
+}

package/src/types/CactusLM.ts

@@ -0,0 +1,73 @@
+export interface CactusLMParams {
+  model?: string;
+  contextSize?: number;
+  corpusDir?: string;
+}
+
+export interface CactusLMDownloadParams {
+  onProgress?: (progress: number) => void;
+}
+
+export interface Message {
+  role: 'user' | 'assistant' | 'system';
+  content?: string;
+  images?: string[];
+}
+
+export interface Options {
+  temperature?: number;
+  topP?: number;
+  topK?: number;
+  maxTokens?: number;
+  stopSequences?: string[];
+}
+
+export interface Tool {
+  type: 'function';
+  name: string;
+  description: string;
+  parameters: {
+    type: 'object';
+    properties: {
+      [key: string]: {
+        type: string;
+        description: string;
+      };
+    };
+    required: string[];
+  };
+}
+
+export interface CactusLMCompleteParams {
+  messages: Message[];
+  options?: Options;
+  tools?: Tool[];
+  onToken?: (token: string) => void;
+}
+
+export interface CactusLMCompleteResult {
+  success: boolean;
+  response: string;
+  functionCalls?: {
+    name: string;
+    arguments: { [key: string]: any };
+  }[];
+  timeToFirstTokenMs: number;
+  totalTimeMs: number;
+  tokensPerSecond: number;
+  prefillTokens: number;
+  decodeTokens: number;
+  totalTokens: number;
+}
+
+export interface CactusLMEmbedParams {
+  text: string;
+}
+
+export interface CactusLMEmbedResult {
+  embedding: number[];
+}
+
+export interface CactusLMGetModelsParams {
+  forceRefresh?: boolean;
+}

package/src/types/CactusModel.ts

@@ -0,0 +1,14 @@
+export interface CactusModel {
+  // API
+  name: string;
+  slug: string;
+  quantization: number;
+  sizeMb: number;
+  downloadUrl: string;
+  supportsToolCalling: boolean;
+  supportsVision: boolean;
+  createdAt: Date;
+
+  // Local
+  isDownloaded: boolean;
+}

package/src/utils/error.ts

@@ -0,0 +1,2 @@
+export const getErrorMessage = (error: unknown): string =>
+  error instanceof Error ? error.message : 'Unknown error';

package/LICENSE.txt

@@ -1,20 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Jhen-Jie Hong
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/android/src/main/CMakeLists.txt

@@ -1,140 +0,0 @@
-cmake_minimum_required(VERSION 3.10)
-
-project(cactus)
-
-set(CMAKE_CXX_STANDARD 17)
-set(SOURCE_DIR ${CMAKE_SOURCE_DIR}/../../../cpp)
-
-include_directories(${SOURCE_DIR})
-include_directories(${SOURCE_DIR}/ggml-cpu)
-include_directories(${SOURCE_DIR}/minja)
-include_directories(${SOURCE_DIR}/tools/mtmd)
-include_directories(${CMAKE_CURRENT_SOURCE_DIR})
-
-set(
-    SOURCE_FILES
-    # Core cactus files
-    ${SOURCE_DIR}/cactus_context.cpp
-    ${SOURCE_DIR}/cactus_loader.cpp
-    ${SOURCE_DIR}/cactus_completion.cpp
-    ${SOURCE_DIR}/cactus_utils.cpp
-    ${SOURCE_DIR}/cactus_embedding.cpp
-    ${SOURCE_DIR}/cactus_lora.cpp
-    ${SOURCE_DIR}/cactus_tokenization.cpp
-    ${SOURCE_DIR}/cactus_multimodal.cpp
-    ${SOURCE_DIR}/cactus_tts.cpp
-    ${SOURCE_DIR}/cactus_bench.cpp
-    ${SOURCE_DIR}/cactus_chat.cpp
-    
-    # GGML core files
-    ${SOURCE_DIR}/ggml.c
-    ${SOURCE_DIR}/ggml-alloc.c
-    ${SOURCE_DIR}/ggml-backend.cpp
-    ${SOURCE_DIR}/ggml-backend-reg.cpp
-    ${SOURCE_DIR}/ggml-opt.cpp
-    ${SOURCE_DIR}/ggml-threading.cpp
-    ${SOURCE_DIR}/ggml-quants.c
-    ${SOURCE_DIR}/gguf.cpp
-    
-    # GGML CPU files
-    ${SOURCE_DIR}/ggml-cpu/ggml-cpu.c
-    ${SOURCE_DIR}/ggml-cpu/ggml-cpu.cpp
-    ${SOURCE_DIR}/ggml-cpu/ggml-cpu-aarch64.cpp
-    ${SOURCE_DIR}/ggml-cpu/ggml-cpu-quants.c
-    ${SOURCE_DIR}/ggml-cpu/ggml-cpu-traits.cpp
-    ${SOURCE_DIR}/ggml-cpu/amx/amx.cpp
-    ${SOURCE_DIR}/ggml-cpu/amx/mmq.cpp
-    ${SOURCE_DIR}/ggml-cpu/unary-ops.cpp
-    ${SOURCE_DIR}/ggml-cpu/binary-ops.cpp
-    ${SOURCE_DIR}/ggml-cpu/sgemm.cpp
-    ${SOURCE_DIR}/ggml-cpu/vec.cpp
-    ${SOURCE_DIR}/ggml-cpu/ops.cpp
-    
-    # LLaMA files  
-    ${SOURCE_DIR}/log.cpp
-    ${SOURCE_DIR}/llama-impl.cpp
-    ${SOURCE_DIR}/llama-grammar.cpp
-    ${SOURCE_DIR}/llama-sampling.cpp
-    ${SOURCE_DIR}/llama-vocab.cpp
-    ${SOURCE_DIR}/llama-adapter.cpp
-    ${SOURCE_DIR}/llama-chat.cpp
-    ${SOURCE_DIR}/llama-context.cpp
-    ${SOURCE_DIR}/llama-kv-cache.cpp
-    ${SOURCE_DIR}/llama-arch.cpp
-    ${SOURCE_DIR}/llama-batch.cpp
-    ${SOURCE_DIR}/llama-cparams.cpp
-    ${SOURCE_DIR}/llama-hparams.cpp
-    ${SOURCE_DIR}/llama.cpp
-    ${SOURCE_DIR}/llama-model.cpp
-    ${SOURCE_DIR}/llama-model-loader.cpp
-    ${SOURCE_DIR}/llama-model-saver.cpp
-    ${SOURCE_DIR}/llama-mmap.cpp
-    ${SOURCE_DIR}/llama-memory.cpp
-    ${SOURCE_DIR}/llama-io.cpp
-    ${SOURCE_DIR}/llama-graph.cpp
-    
-    # Common files
-    ${SOURCE_DIR}/sampling.cpp
-    ${SOURCE_DIR}/unicode-data.cpp
-    ${SOURCE_DIR}/unicode.cpp
-    ${SOURCE_DIR}/common.cpp
-    ${SOURCE_DIR}/chat.cpp
-    ${SOURCE_DIR}/json-schema-to-grammar.cpp
-    
-    # Template and JSON headers (header-only)
-    ${SOURCE_DIR}/minja/minja.hpp
-    ${SOURCE_DIR}/minja/chat-template.hpp
-    ${SOURCE_DIR}/json.hpp
-    
-    # Multimodal/MTMD files
-    ${SOURCE_DIR}/tools/mtmd/mtmd.cpp
-    ${SOURCE_DIR}/tools/mtmd/mtmd-audio.cpp
-    ${SOURCE_DIR}/tools/mtmd/clip.cpp
-    ${SOURCE_DIR}/tools/mtmd/mtmd-helper.cpp
-    
-    # JNI files
-    ${CMAKE_CURRENT_SOURCE_DIR}/jni-utils.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/jni.cpp
-)
-
-find_library(LOG_LIB log)
-
-function(build_library target_name cpu_flags)
-    add_library(
-        ${target_name}
-        SHARED
-        ${SOURCE_FILES}
-    )
-
-    target_link_libraries(${target_name} ${LOG_LIB} android)
-
-    target_compile_options(${target_name} PRIVATE -DLM_GGML_USE_CPU -DLM_GGML_USE_CPU_AARCH64 -pthread ${cpu_flags})
-
-    if (${CMAKE_BUILD_TYPE} STREQUAL "Debug")
-        target_compile_options(${target_name} PRIVATE -DCACTUS_ANDROID_ENABLE_LOGGING)
-    endif ()
-
-    target_compile_options(${target_name} PRIVATE -O3 -DNDEBUG)
-    target_compile_options(${target_name} PRIVATE -fvisibility=hidden -fvisibility-inlines-hidden)
-    target_compile_options(${target_name} PRIVATE -ffunction-sections -fdata-sections)
-
-    target_link_options(${target_name} PRIVATE -Wl,--gc-sections)
-    target_link_options(${target_name} PRIVATE -Wl,--exclude-libs,ALL)
-    target_link_options(${target_name} PRIVATE -flto)
-    target_link_options(${target_name} PRIVATE -Wl,-z,max-page-size=16384)
-
-endfunction()
-
-build_library("cactus" "")
-
-if (${ANDROID_ABI} STREQUAL "arm64-v8a")
-    build_library("cactus_v8" "-march=armv8-a")
-    build_library("cactus_v8_2" "-march=armv8.2-a")
-    build_library("cactus_v8_2_dotprod" "-march=armv8.2-a+dotprod")
-    build_library("cactus_v8_2_i8mm" "-march=armv8.2-a+i8mm")
-    build_library("cactus_v8_2_dotprod_i8mm" "-march=armv8.2-a+dotprod+i8mm")
-
-elseif (${ANDROID_ABI} STREQUAL "x86_64")
-    build_library("cactus_x86_64" "-march=x86-64" "-mtune=intel" "-msse4.2" "-mpopcnt")
-
-endif ()