typescript: fix final bugs and polishing, circle ci documentation (no…

…mic-ai#960) * fix: esm and cjs compatibility Signed-off-by: Jacob Nguyen <[email protected]> * Update prebuild.js Signed-off-by: Jacob Nguyen <[email protected]> * fix gpt4all.js Signed-off-by: Jacob Nguyen <[email protected]> * Fix compile for windows and linux again. PLEASE DON'T REVERT THISgit gui! * version bump * polish up spec and build scripts * lock file refresh * fix: proper resource closing and error handling * check make sure libPath not null * add msvc build script and update readme requirements * python workflows in circleci * dummy python change * no need for main * second hold for pypi deploy * let me deploy pls * bring back when condition * Typo, ignore list (nomic-ai#967) Fix typo in javadoc, Add word to ignore list for codespellrc --------- Co-authored-by: felix <[email protected]> * llmodel: change tokenToString to not use string_view (nomic-ai#968) fixes a definite use-after-free and likely avoids some other potential ones - std::string will convert to a std::string_view automatically but as soon as the std::string in question goes out of scope it is already freed and the string_view is pointing at freed memory - this is *mostly* fine if its returning a reference to the tokenizer's internal vocab table but it's, imo, too easy to return a reference to a dynamically constructed string with this as replit is doing (and unfortunately needs to do to convert the internal whitespace replacement symbol back to a space) * Initial Library Loader for .NET Bindings / Update bindings to support newest changes (nomic-ai#763) * Initial Library Loader * Load library as part of Model factory * Dynamically search and find the dlls * Update tests to use locally built runtimes * Fix dylib loading, add macos runtime support for sample/tests * Bypass automatic loading by default. * Only set CMAKE_OSX_ARCHITECTURES if not already set, allow cross-compile * Switch Loading again * Update build scripts for mac/linux * Update bindings to support newest breaking changes * Fix build * Use llmodel for Windows * Actually, it does need to be libllmodel * Name * Remove TFMs, bypass loading by default * Fix script * Delete mac script --------- Co-authored-by: Tim Miller <[email protected]> * bump llama.cpp mainline to latest (nomic-ai#964) * fix prompt context so it's preserved in class * update setup.py * metal replit (nomic-ai#931) metal+replit makes replit work with Metal and removes its use of `mem_per_token` in favor of fixed size scratch buffers (closer to llama.cpp) * update documentation scripts and generation to include readme.md * update readme and documentation for source * begin tests, import jest, fix listModels export * fix typo * chore: update spec * fix: finally, reduced potential of empty string * chore: add stub for createTokenSream * refactor: protecting resources properly * add basic jest tests * update * update readme * refactor: namespace the res variable * circleci integration to automatically build docs * add starter docs * typo * more circle ci typo * forgot to add nodejs circle ci orb * fix circle ci * feat: @iimez verify download and fix prebuild script * fix: oops, option name wrong * fix: gpt4all utils not emitting docs * chore: fix up scripts * fix: update docs and typings for md5 sum * fix: macos compilation * some refactoring * Update index.cc Signed-off-by: Jacob Nguyen <[email protected]> * update readme and enable exceptions on mac * circle ci progress * basic embedding with sbert (not tested & cpp side only) * fix circle ci * fix circle ci * update circle ci script * bruh * fix again * fix * fixed required workflows * fix ci * fix pwd * fix pwd * update ci * revert * fix * prevent rebuild * revmove noop * Update continue_config.yml Signed-off-by: Jacob Nguyen <[email protected]> * Update binding.gyp Signed-off-by: Jacob Nguyen <[email protected]> * fix fs not found * remove cpp 20 standard * fix warnings, safer way to calculate arrsize * readd build backend * basic embeddings and yarn test" * fix circle ci Signed-off-by: Jacob Nguyen <[email protected]> Update continue_config.yml Signed-off-by: Jacob Nguyen <[email protected]> Signed-off-by: Jacob Nguyen <[email protected]> fix macos paths update readme and roadmap split up spec update readme check for url in modelsjson update docs and inline stuff update yarn configuration and readme update readme readd npm publish script add exceptions bruh one space broke the yaml codespell oops forgot to add runtimes folder bump version try code snippet https://support.circleci.com/hc/en-us/articles/8325075309339-How-to-install-NPM-on-Windows-images add fallback for unknown architectures attached to wrong workspace hopefuly fix moving everything under backend to persist should work now * update circle ci script * prevent rebuild * revmove noop * Update continue_config.yml Signed-off-by: Jacob Nguyen <[email protected]> * Update binding.gyp Signed-off-by: Jacob Nguyen <[email protected]> * fix fs not found * remove cpp 20 standard * fix warnings, safer way to calculate arrsize * readd build backend * basic embeddings and yarn test" * fix circle ci Signed-off-by: Jacob Nguyen <[email protected]> Update continue_config.yml Signed-off-by: Jacob Nguyen <[email protected]> Signed-off-by: Jacob Nguyen <[email protected]> fix macos paths update readme and roadmap split up spec update readme check for url in modelsjson update docs and inline stuff update yarn configuration and readme update readme readd npm publish script add exceptions bruh one space broke the yaml codespell oops forgot to add runtimes folder bump version try code snippet https://support.circleci.com/hc/en-us/articles/8325075309339-How-to-install-NPM-on-Windows-images add fallback for unknown architectures attached to wrong workspace hopefuly fix moving everything under backend to persist should work now * Update README.md Signed-off-by: Jacob Nguyen <[email protected]> --------- Signed-off-by: Jacob Nguyen <[email protected]> Co-authored-by: Adam Treat <[email protected]> Co-authored-by: Richard Guo <[email protected]> Co-authored-by: Felix Zaslavskiy <[email protected]> Co-authored-by: felix <[email protected]> Co-authored-by: Aaron Miller <[email protected]> Co-authored-by: Tim Miller <[email protected]> Co-authored-by: Tim Miller <[email protected]>
DEVBOX10 · Jul 25, 2023 · 545c23b · 545c23b
1 parent b3f84c5
commit 545c23b
Show file tree

Hide file tree

Showing 30 changed files with 8,091 additions and 3,205 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -12,6 +12,7 @@ workflows:
           config-path: .circleci/continue_config.yml
           mapping: |
             gpt4all-bindings/python/.* run-python-workflow true
+            gpt4all-bindings/typescript/.* run-ts-workflow true
             gpt4all-bindings/csharp/.* run-csharp-workflow true
             gpt4all-backend/.* run-chat-workflow true
             gpt4all-chat/.* run-chat-workflow true

diff --git a/.circleci/continue_config.yml b/.circleci/continue_config.yml
@@ -2,6 +2,7 @@ version: 2.1
 orbs:
   win: circleci/[email protected]
   python: circleci/[email protected]
+  node: circleci/[email protected]
 
 parameters:
   run-default-workflow:
@@ -13,6 +14,9 @@ parameters:
   run-chat-workflow:
     type: boolean
     default: false
+  run-ts-workflow:
+    type: boolean
+    default: false
   run-csharp-workflow:
     type: boolean
     default: false
@@ -156,12 +160,26 @@ jobs:
               -S ../gpt4all-chat \
               -B .
             ~/Qt/Tools/CMake/CMake.app/Contents/bin/cmake --build . --target all
-
+  build-ts-docs: 
+    docker: 
+      - image: cimg/base:stable
+    steps:
+      - checkout
+      - node/install:
+          install-yarn: true
+          node-version: "18.16"
+      - run: node --version
+      - node/install-packages:
+          pkg-manager: yarn
+      - run:
+          name: build docs ts yo
+          command: yarn docs:build
+
   build-py-docs:
     docker:
       - image: circleci/python:3.8
     steps:
-      - checkout
+      - checkout 
       - run:
           name: Install dependencies
           command: |
@@ -612,6 +630,160 @@ jobs:
       - store_artifacts:
           path: gpt4all-bindings/csharp/Gpt4All/bin/Release
 
+  build-nodejs-linux: 
+    docker: 
+      - image: cimg/base:stable
+    steps:
+      - checkout
+      - attach_workspace:
+          at: /tmp/gpt4all-backend
+      - node/install:
+          install-yarn: true
+          node-version: "18.16"
+      - run: node --version
+      - node/install-packages:
+          app-dir: gpt4all-bindings/typescript
+          pkg-manager: yarn
+      - run:
+          command: | 
+            cd gpt4all-bindings/typescript
+            yarn prebuildify -t 18.16.0 --napi
+      - run: 
+          command: |
+            mkdir -p gpt4all-backend/prebuilds/linux-x64
+            mkdir -p gpt4all-backend/runtimes/linux-x64
+            cp /tmp/gpt4all-backend/runtimes/linux-x64/*-*.so gpt4all-backend/runtimes/linux-x64
+            cp gpt4all-bindings/typescript/prebuilds/linux-x64/*.node gpt4all-backend/prebuilds/linux-x64
+      - persist_to_workspace:
+          root: gpt4all-backend
+          paths:
+            - prebuilds/linux-x64/*.node 
+            - runtimes/linux-x64/*-*.so
+  build-nodejs-macos: 
+    macos:
+      xcode: "14.0.0"
+    steps:
+      - checkout
+      - attach_workspace:
+          at: /tmp/gpt4all-backend
+      - node/install:
+          install-yarn: true
+          node-version: "18.16"
+      - run: node --version
+      - node/install-packages:
+          app-dir: gpt4all-bindings/typescript
+          pkg-manager: yarn
+      - run:
+          command: | 
+            cd gpt4all-bindings/typescript
+            yarn prebuildify -t 18.16.0 --napi
+      - run: 
+          name: "Persisting all necessary things to workspace"
+          command: |  
+            mkdir -p gpt4all-backend/prebuilds/darwin-x64
+            mkdir -p gpt4all-backend/runtimes/darwin-x64
+            cp /tmp/gpt4all-backend/runtimes/osx-x64/*-*.* gpt4all-backend/runtimes/darwin-x64
+            cp gpt4all-bindings/typescript/prebuilds/darwin-x64/*.node gpt4all-backend/prebuilds/darwin-x64
+      - persist_to_workspace:
+          root: gpt4all-backend
+          paths:
+            - prebuilds/darwin-x64/*.node
+            - runtimes/darwin-x64/*-*.*
+
+  build-nodejs-windows: 
+    executor:
+      name: win/default
+      size: large
+      shell: powershell.exe -ExecutionPolicy Bypass
+    steps:
+      - checkout
+      - attach_workspace:
+          at: /tmp/gpt4all-backend
+      - run: choco install wget -y
+      - run:
+         command: wget https://nodejs.org/dist/v18.16.0/node-v18.16.0-x86.msi -P C:\Users\circleci\Downloads\
+         shell: cmd.exe
+      - run: MsiExec.exe /i C:\Users\circleci\Downloads\node-v18.16.0-x86.msi /qn
+      - run: 
+          command: |
+              Start-Process powershell -verb runAs -Args "-start GeneralProfile"
+              nvm install 18.16.0
+              nvm use 18.16.0
+      - run: node --version 
+      - run:           
+          command: |
+            npm install -g yarn
+            cd gpt4all-bindings/typescript
+            yarn install
+      - run:
+          command: | 
+            cd gpt4all-bindings/typescript
+            yarn prebuildify -t 18.16.0 --napi 
+      - run: 
+          command: |
+            mkdir -p gpt4all-backend/prebuilds/win32-x64
+            mkdir -p gpt4all-backend/runtimes/win32-x64
+            cp /tmp/gpt4all-backend/runtimes/win-x64_msvc/*-*.dll gpt4all-backend/runtimes/win32-x64
+            cp gpt4all-bindings/typescript/prebuilds/win32-x64/*.node gpt4all-backend/prebuilds/win32-x64
+        
+      - persist_to_workspace:
+          root: gpt4all-backend
+          paths:
+            - prebuilds/win32-x64/*.node
+            - runtimes/win32-x64/*-*.dll
+
+  prepare-npm-pkg:
+    docker: 
+      - image: cimg/base:stable
+    steps:
+      - attach_workspace:
+          at: /tmp/gpt4all-backend
+      - checkout
+      - node/install:
+          install-yarn: true
+          node-version: "18.16"
+      - run: node --version
+      - run: 
+          command: |
+            cd gpt4all-bindings/typescript
+            # excluding llmodel. nodejs bindings dont need llmodel.dll
+            mkdir -p runtimes/win32-x64/native
+            mkdir -p prebuilds/win32-x64/
+            cp /tmp/gpt4all-backend/runtimes/win-x64_msvc/*-*.dll runtimes/win32-x64/native/ 
+            cp /tmp/gpt4all-backend/prebuilds/win32-x64/*.node prebuilds/win32-x64/    
+
+            mkdir -p runtimes/linux-x64/native 
+            mkdir -p prebuilds/linux-x64/
+            cp /tmp/gpt4all-backend/runtimes/linux-x64/*-*.so runtimes/linux-x64/native/ 
+            cp /tmp/gpt4all-backend/prebuilds/linux-x64/*.node prebuilds/linux-x64/    
+
+            mkdir -p runtimes/darwin-x64/native
+            mkdir -p prebuilds/darwin-x64/
+            cp /tmp/gpt4all-backend/runtimes/darwin-x64/*-*.* runtimes/darwin-x64/native/
+            cp /tmp/gpt4all-backend/prebuilds/darwin-x64/*.node prebuilds/darwin-x64/    
+            
+            # Fallback build if user is not on above prebuilds
+            mv -f binding.ci.gyp binding.gyp
+
+            mkdir gpt4all-backend
+            cd ../../gpt4all-backend
+            mv llmodel.h llmodel.cpp llmodel_c.cpp llmodel_c.h sysinfo.h dlhandle.h ../gpt4all-bindings/typescript/gpt4all-backend/
+            
+      # Test install
+      - node/install-packages:
+          app-dir: gpt4all-bindings/typescript
+          pkg-manager: yarn
+          override-ci-command: yarn install
+      - run: 
+          command: | 
+            cd gpt4all-bindings/typescript
+            yarn run test
+      - run:
+          command: |
+            cd gpt4all-bindings/typescript
+            npm set //registry.npmjs.org/:_authToken=$NPM_TOKEN
+            npm publish --access public --tag alpha
+
 workflows:
   version: 2
   default:
@@ -635,6 +807,11 @@ workflows:
   deploy-docs:
     when: << pipeline.parameters.run-python-workflow >>
     jobs:
+      - build-ts-docs:
+          filters:
+            branches:
+              only:
+                - main
       - build-py-docs:
           filters:
             branches:
@@ -679,11 +856,14 @@ workflows:
         or:
          - << pipeline.parameters.run-python-workflow >>
          - << pipeline.parameters.run-csharp-workflow >>
+         - <<   pipeline.parameters.run-ts-workflow   >>
     jobs:
       - hold:
           type: approval
       - nuget-hold:
           type: approval
+      - npm-hold:
+          type: approval
       - build-bindings-backend-linux:
           filters:
             branches:
@@ -708,6 +888,41 @@ workflows:
               only:
           requires:
             - hold
+
+      # NodeJs Jobs 
+      - prepare-npm-pkg: 
+          filters:
+            branches:
+              only:
+          requires:
+            - npm-hold
+            - build-nodejs-linux
+            - build-nodejs-windows
+            - build-nodejs-macos
+      - build-nodejs-linux:
+          filters:
+            branches:
+              only:
+          requires:
+            - npm-hold
+            - build-bindings-backend-linux
+      - build-nodejs-windows:
+          filters:
+            branches:
+              only:
+          requires:
+            - npm-hold
+            - build-bindings-backend-windows-msvc
+      - build-nodejs-macos:
+          filters:
+            branches:
+              only:
+          requires:
+            - npm-hold
+            - build-bindings-backend-macos
+
+
+      # CSharp Jobs
       - build-csharp-linux:
           filters:
             branches:
@@ -719,7 +934,7 @@ workflows:
             branches:
               only:
           requires:
-            - build-bindings-backend-windows
+              - build-bindings-backend-windows
       - build-csharp-macos:
           filters:
             branches: