Merge branch 'dev' into chore/fix-macos-bin

janhq · Jul 4, 2024 · 5274625 · 5274625
2 parents 73d7c2e + b0a0356
commit 5274625
Show file tree

Hide file tree

Showing 33 changed files with 284 additions and 573 deletions.
diff --git a/README.md b/README.md
@@ -21,8 +21,8 @@ Cortex currently supports 3 inference engines:
 
 ## Quicklinks
 
-- [Homepage](https://cortex.jan.ai/)
-- [Docs](https://cortex.jan.ai/docs/)
+- [Homepage](https://cortex.so/)
+- [Docs](https://cortex.so/docs/)
 
 ## Quickstart
 ### Prerequisites
@@ -36,31 +36,28 @@ Ensure that your system meets the following requirements to run Cortex:
   - Windows 10 or higher.
   - Ubuntu 22.04 and later.
 
-> Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started.
+> Visit [Quickstart](https://cortex.so/docs/quickstart) to get started.
 
 ### NPM
+Install using NPM package:
 ``` bash
 # Install using NPM
 npm i -g cortexso
-# Install using Brew
-brew tap janhq/cortexso
-brew install cortexso
 # Run model
 cortex run llama3
 # To uninstall globally using NPM
 npm uninstall -g cortexso
 ```
 
 ### Homebrew
+Install using Homebrew:
 ``` bash
 # Install using Brew
-brew tap janhq/cortexso
 brew install cortexso
 # Run model
 cortex run llama3
 # To uninstall using Brew
 brew uninstall cortexso
-brew untap janhq/cortexso
 ```
 > You can also install Cortex using the Cortex Installer available on [GitHub Releases](https://github.com/janhq/cortex/releases).
 
@@ -103,18 +100,18 @@ npm link
 ## Cortex CLI Commands
 
 The following CLI commands are currently available.
-See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information.
+See [CLI Reference Docs](https://cortex.so/docs/cli) for more information.
 
 ```bash
 
-  serve               Providing API endpoint for Cortex backend
-  chat                Send a chat request to a model
-  init|setup          Init settings and download cortex's dependencies
-  ps                  Show running models and their status
-  kill                Kill running cortex processes
+  serve               Providing API endpoint for Cortex backend.
+  chat                Send a chat request to a model.
+  init|setup          Init settings and download cortex's dependencies.
+  ps                  Show running models and their status.
+  kill                Kill running cortex processes.
   pull|download       Download a model. Working with HuggingFace model id.
-  run [options]       EXPERIMENTAL: Shortcut to start a model and chat
-  models              Subcommands for managing models
+  run [options]       EXPERIMENTAL: Shortcut to start a model and chat.
+  models              Subcommands for managing models.
   models list         List all available models.
   models pull         Download a specified model.
   models remove       Delete a specified model.
@@ -125,6 +122,15 @@ See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information.
   benchmark           Benchmark and analyze the performance of a specific AI model using your system.
   presets             Show all the available model presets within Cortex.
   telemetry           Retrieve telemetry logs for monitoring and analysis.
+  embeddings          Creates an embedding vector representing the input text.
+  engines             Subcommands for managing engines.
+  engines get         Get an engine details.
+  engines list        Get all the available Cortex engines.
+  engines init        Setup and download the required dependencies to run cortex engines.
+  configs             Subcommands for managing configurations.
+  configs get         Get a configuration details.
+  configs list        Get all the available configurations.
+  configs set         Set a configuration.
 ```
 
 ## Contact Support

diff --git a/assets/cortex-banner.png b/assets/cortex-banner.png
diff --git a/cortex-js/README.md b/cortex-js/README.md
@@ -38,29 +38,27 @@ Ensure that your system meets the following requirements to run Cortex:
 
 > Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started.
 
+
 ### NPM
+Install using NPM package:
 ``` bash
 # Install using NPM
 npm i -g cortexso
-# Install using Brew
-brew tap janhq/cortexso
-brew install cortexso
 # Run model
 cortex run llama3
 # To uninstall globally using NPM
 npm uninstall -g cortexso
 ```
 
 ### Homebrew
+Install using Homebrew:
 ``` bash
 # Install using Brew
-brew tap janhq/cortexso
 brew install cortexso
 # Run model
 cortex run llama3
 # To uninstall using Brew
 brew uninstall cortexso
-brew untap janhq/cortexso
 ```
 > You can also install Cortex using the Cortex Installer available on [GitHub Releases](https://github.com/janhq/cortex/releases).
 
@@ -107,14 +105,14 @@ See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information.
 
 ```bash
 
-  serve               Providing API endpoint for Cortex backend
-  chat                Send a chat request to a model
-  init|setup          Init settings and download cortex's dependencies
-  ps                  Show running models and their status
-  kill                Kill running cortex processes
+  serve               Providing API endpoint for Cortex backend.
+  chat                Send a chat request to a model.
+  init|setup          Init settings and download cortex's dependencies.
+  ps                  Show running models and their status.
+  kill                Kill running cortex processes.
   pull|download       Download a model. Working with HuggingFace model id.
-  run [options]       EXPERIMENTAL: Shortcut to start a model and chat
-  models              Subcommands for managing models
+  run [options]       EXPERIMENTAL: Shortcut to start a model and chat.
+  models              Subcommands for managing models.
   models list         List all available models.
   models pull         Download a specified model.
   models remove       Delete a specified model.
@@ -125,6 +123,15 @@ See [CLI Reference Docs](https://cortex.jan.ai/docs/cli) for more information.
   benchmark           Benchmark and analyze the performance of a specific AI model using your system.
   presets             Show all the available model presets within Cortex.
   telemetry           Retrieve telemetry logs for monitoring and analysis.
+  embeddings          Creates an embedding vector representing the input text.
+  engines             Subcommands for managing engines.
+  engines get         Get an engine details.
+  engines list        Get all the available Cortex engines.
+  engines init        Setup and download the required dependencies to run cortex engines.
+  configs             Subcommands for managing configurations.
+  configs get         Get a configuration details.
+  configs list        Get all the available configurations.
+  configs set         Set a configuration.
 ```
 
 ## Contact Support

diff --git a/cortex-js/cpuinfo/README.md b/cortex-js/cpuinfo/README.md
diff --git a/cortex-js/cpuinfo/binding.gyp b/cortex-js/cpuinfo/binding.gyp
diff --git a/cortex-js/cpuinfo/index.d.ts b/cortex-js/cpuinfo/index.d.ts
diff --git a/cortex-js/cpuinfo/index.js b/cortex-js/cpuinfo/index.js
diff --git a/cortex-js/cpuinfo/package.json b/cortex-js/cpuinfo/package.json
diff --git a/cortex-js/cpuinfo/src/CPUID.h b/cortex-js/cpuinfo/src/CPUID.h