|
|
---
|
|
|
license: agpl-3.0
|
|
|
---
|
|
|
|
|
|
# Apex Studio Server
|
|
|
|
|
|
This repository serves as a distribution hub for pre-bundled versions of the **Apex Studio** Python backend. The canonical version of these bundles is hosted on **[Hugging Face](https://huggingface.co/totoku/apex-studio-server/tree/main)**.
|
|
|
|
|
|
It contains compressed bundles (`.tar.zst`) optimized for different platforms, architectures, and hardware acceleration backends.
|
|
|
|
|
|
## 📦 Bundles
|
|
|
|
|
|
Apex Studio is split into two main components:
|
|
|
- **`python-api`**: A fully functional environment containing all necessary dependencies and the API service layer.
|
|
|
- **`python-code`**: The core execution engine and model implementation logic (source code only, no dependencies included).
|
|
|
|
|
|
Files are organized by version (e.g., `/0.1.0/`).
|
|
|
|
|
|
### Naming Convention
|
|
|
|
|
|
Each bundle follows this pattern:
|
|
|
`{component}-{version}-{os}-{arch}-{acceleration}-{python_version}.tar.zst`
|
|
|
|
|
|
| Segment | Options | Description |
|
|
|
| :--- | :--- | :--- |
|
|
|
| **Component** | `python-api`, `python-code` | The part of the system contained in the bundle. |
|
|
|
| **Version** | e.g., `0.1.0` | The release version of Apex Studio. |
|
|
|
| **OS** | `darwin`, `linux`, `win32` | Target Operating System. |
|
|
|
| **Arch** | `arm64`, `x86_64` | CPU Architecture (Apple Silicon vs Intel/AMD). |
|
|
|
| **Acceleration** | `mps`, `cuda`, `cpu` | Hardware backend (Metal, NVIDIA CUDA, or Generic CPU). |
|
|
|
| **Python** | `cp311`, `cp312` | Required CPython version. |
|
|
|
|
|
|
## 🚀 Usage
|
|
|
|
|
|
These bundles are compressed using **Zstandard** (`.zst`) for maximum efficiency.
|
|
|
|
|
|
### Extraction (Linux & macOS)
|
|
|
|
|
|
To extract a bundle, use `tar` with Zstandard support:
|
|
|
|
|
|
```bash
|
|
|
# Example for macOS (Apple Silicon)
|
|
|
tar --zstd -xf python-api-0.1.0-darwin-arm64-mps-cp312.tar.zst
|
|
|
```
|
|
|
|
|
|
Alternatively, if your `tar` version does not support `--zstd` directly:
|
|
|
|
|
|
```bash
|
|
|
zstd -d python-api-0.1.0-darwin-arm64-mps-cp312.tar.zst -o python-api.tar
|
|
|
tar -xf python-api.tar
|
|
|
```
|
|
|
|
|
|
### Extraction (Windows)
|
|
|
|
|
|
On Windows, you can use the following methods:
|
|
|
|
|
|
#### 1. Using 7-Zip (Recommended)
|
|
|
If you have **7-Zip** (with the Zstandard plugin) or **7-Zip-zstd** installed, you can right-click the file and extract it directly.
|
|
|
|
|
|
#### 2. Using Command Line (PowerShell/CMD)
|
|
|
If you have `zstd` and `tar` in your PATH (often available via Git Bash or Chocolatey):
|
|
|
|
|
|
```powershell
|
|
|
# Decompress the zstd file first
|
|
|
zstd -d python-api-0.1.0-win32-x86_64-cuda-cp312.tar.zst
|
|
|
|
|
|
# Then extract the resulting tar
|
|
|
tar -xf python-api-0.1.0-win32-x86_64-cuda-cp312.tar
|
|
|
```
|
|
|
|
|
|
#### 3. Using WSL
|
|
|
If you have Windows Subsystem for Linux (WSL) installed:
|
|
|
|
|
|
```bash
|
|
|
tar --zstd -xf python-api-0.1.0-win32-x86_64-cuda-cp312.tar.zst
|
|
|
```
|
|
|
|
|
|
## 🛠️ Integration
|
|
|
|
|
|
These bundles are typically fetched and managed automatically by the Apex Studio desktop application, but they can be manually deployed for headless or custom server environments.
|
|
|
|
|
|
## 📜 License
|
|
|
|
|
|
This repository and its contents are licensed under the **AGPL-3.0 License**.
|
|
|
|
