cactus-react-native 0.0.1 → 0.1.1

package/LICENSE.txt

@@ -0,0 +1,20 @@
+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/README.md

@@ -6,9 +6,11 @@ A lightweight, high-performance framework for running AI models on mobile device
 
 ```bash
 # Using npm
+npm install react-native-fs
 npm install cactus-react-native
 
 # Using yarn
+yarn add react-native-fs
 yarn add cactus-react-native
 
 # For iOS, install pods if not on Expo
@@ -227,4 +229,4 @@ This example demonstrates:
 
 ## License
 
-This project is licensed under the MIT License.
+This project is licensed under the Apache 2.0 License.

package/android/src/main/CMakeLists.txt

@@ -3,26 +3,54 @@ cmake_minimum_required(VERSION 3.10)
 project(cactus)
 
 set(CMAKE_CXX_STANDARD 17)
-# Use cactus as the C++ source directory
-set(SOURCE_DIR ${CMAKE_SOURCE_DIR}/../../../cactus)
+set(SOURCE_DIR ${CMAKE_SOURCE_DIR}/../../../../cactus)
 
 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-cpu.c
-    ${SOURCE_DIR}/ggml-cpu.cpp
-    ${SOURCE_DIR}/ggml-cpu-aarch64.cpp
-    ${SOURCE_DIR}/ggml-cpu-quants.c
-    ${SOURCE_DIR}/ggml-cpu-traits.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
@@ -39,26 +67,34 @@ set(
     ${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-vocab.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}/sgemm.cpp
     ${SOURCE_DIR}/common.cpp
     ${SOURCE_DIR}/chat.cpp
     ${SOURCE_DIR}/json-schema-to-grammar.cpp
-    ${SOURCE_DIR}/json.hpp
-    ${SOURCE_DIR}/amx/amx.cpp
-    ${SOURCE_DIR}/amx/mmq.cpp
+    
+    # Template and JSON headers (header-only)
     ${SOURCE_DIR}/minja/minja.hpp
     ${SOURCE_DIR}/minja/chat-template.hpp
-    ${SOURCE_DIR}/cactus.cpp
-    ${CMAKE_SOURCE_DIR}/jni-utils.h
-    ${CMAKE_SOURCE_DIR}/jni.cpp
+    ${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)
@@ -78,17 +114,16 @@ function(build_library target_name cpu_flags)
         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_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,--gc-sections)
+    target_link_options(${target_name} PRIVATE -Wl,--exclude-libs,ALL)
+    target_link_options(${target_name} PRIVATE -flto)
 
 endfunction()
 
-# Default target (no specific CPU features)
 build_library("cactus" "")
 
 if (${ANDROID_ABI} STREQUAL "arm64-v8a")
@@ -101,4 +136,4 @@ if (${ANDROID_ABI} STREQUAL "arm64-v8a")
 elseif (${ANDROID_ABI} STREQUAL "x86_64")
     build_library("cactus_x86_64" "-march=x86-64" "-mtune=intel" "-msse4.2" "-mpopcnt")
 
-endif ()
+endif ()