Skip to content

Commit

Permalink
Merge pull request #237 from NexaAI/perry-debug
Browse files Browse the repository at this point in the history
update executable download link
  • Loading branch information
zhycheng614 authored Nov 12, 2024
2 parents c62acc6 + d2be272 commit 74f33bd
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

<video src="https://user-images.githubusercontent.com/assets/375570dc-0e7a-4a99-840d-c1ef6502e5aa.mp4" autoplay muted loop playsinline style="max-width: 100%;"></video>

<h1>Nexa SDK - Local On-Device Inference Framework</h1>
Expand All @@ -12,7 +11,6 @@

[**On-Device Model Hub**](https://nexa.ai/models) | [**Documentation**](https://docs.nexa.ai/) | [**Discord**](https://discord.gg/thRu2HaK4D) | [**Blogs**](https://nexa.ai/blogs) | [**X (Twitter)**](https://x.com/nexa_ai)


**Nexa SDK** is a local on-device inference framework for ONNX and GGML models, supporting text generation, image generation, vision-language models (VLM), audio-language models, speech-to-text (ASR), and text-to-speech (TTS) capabilities. Installable via Python Package or Executable Installer.

### Features
Expand All @@ -32,24 +30,27 @@
Welcome to submit your requests through [issues](https://github.com/NexaAI/nexa-sdk/issues/new/choose), we ship weekly.

## Install Option 1: Executable Installer

<p>
<a href="https://public-storage.nexa4ai.com/nexa-sdk-executable-installer/nexa-macos-installer.pkg">
<a href="https://public-storage.nexa4ai.com/nexa-sdk-executable-installer/nexa-sdk-0.0.9.1-macos-installer.pkg">
<img src="./assets/mac.png" style="height: 1em; width: auto" /> <strong> macOS Installer </strong>
</a>
</p>

<p>
<a href="https://public-storage.nexa4ai.com/nexa-sdk-executable-installer/nexa-sdk-windows-setup.exe">
<a href="https://public-storage.nexa4ai.com/nexa-sdk-executable-installer/nexa-sdk-0.0.9.1-windows-setup.exe">
<img src="./assets/windows.png" style="height: 1em; width: auto" /> <strong>Windows Installer</strong>
</a>
</p>

<strong> <img src="./assets/linux.png" style="height: 1em; width: auto" /> Linux Installer </strong>
<strong> <img src="./assets/linux.png" style="height: 1em; width: auto" /> Linux Installer </strong>

```bash
curl -fsSL https://public-storage.nexa4ai.com/install.sh | sh
```

Currently, executable installer does not support local UI. For local UI, please install using python package below.

<details>
<summary><strong>FAQ: cannot use executable with nexaai python package already installed</strong></summary>

Expand All @@ -61,7 +62,6 @@ nexa-exe <command>

</details>


## Install Option 2: Python Package

We have released pre-built wheels for various Python versions, platforms, and backends for convenient installation on our [index page](https://nexaai.github.io/nexa-sdk/whl/).
Expand Down Expand Up @@ -100,7 +100,6 @@ CMAKE_ARGS="-DGGML_METAL=ON -DSD_METAL=ON" pip install nexaai --prefer-binary --

<details> <summary><strong style="font-size: 1.2em;">Nvidia GPU (CUDA)</strong></summary>


To install with CUDA support, make sure you have [CUDA Toolkit 12.0 or later](https://developer.nvidia.com/cuda-12-0-0-download-archive) installed.

For **Linux**:
Expand All @@ -127,7 +126,6 @@ For **Windows Git Bash**:
CMAKE_ARGS="-DGGML_CUDA=ON -DSD_CUBLAS=ON" pip install nexaai --prefer-binary --index-url https://nexaai.github.io/nexa-sdk/whl/cu124 --extra-index-url https://pypi.org/simple --no-cache-dir
```


<details>
<summary><strong>FAQ: Building Issues for llava</strong></summary>

Expand Down Expand Up @@ -159,7 +157,6 @@ CMAKE_ARGS="-DGGML_HIPBLAS=on" pip install nexaai --prefer-binary --index-url ht

<details> <summary><strong style="font-size: 1.2em;">GPU (Vulkan)</strong></summary>


To install with Vulkan support, make sure you have [Vulkan SDK 1.3.261.1 or later](https://vulkan.lunarg.com/sdk/home) installed.

For **Windows PowerShell**:
Expand Down Expand Up @@ -267,6 +264,7 @@ Supported model examples (full list at [Model Hub](https://nexa.ai/models)):
> 4. For Chinese developers, we recommend you to use <strong>Tsinghua Open Source Mirror</strong> as extra index url, just replace `--extra-index-url https://pypi.org/simple` with `--extra-index-url https://pypi.tuna.tsinghua.edu.cn/simple` in provided commands.
### CLI Reference

Here's a brief overview of the main CLI commands:

- `nexa run`: Run inference for various tasks using GGUF models.
Expand Down

0 comments on commit 74f33bd

Please sign in to comment.