Metadata-Version: 2.4
Name: edge-studio
Version: 0.0.1rc1
Summary: Edge Studio — on-device LLM optimization workbench for Apple Silicon
Author: AtomGradient
License-Expression: MIT
Project-URL: Homepage, https://github.com/AtomGradient/edge-studio
Project-URL: Documentation, https://atomgradient.github.io/edge-developers/
Project-URL: Repository, https://github.com/AtomGradient/edge-studio
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastapi<1.0,>=0.115.0
Requires-Dist: uvicorn[standard]<1.0,>=0.30.0
Requires-Dist: pydantic<3.0,>=2.0.0
Requires-Dist: PyYAML>=6.0
Requires-Dist: platformdirs>=4.0
Requires-Dist: python-multipart>=0.0.7
Requires-Dist: httpx[socks]>=0.24.0
Requires-Dist: safetensors<1.0,>=0.4.0
Requires-Dist: numpy<3.0,>=2.3.0
Requires-Dist: tokenizers<0.23.0,>=0.22.0
Requires-Dist: transformers<6.0.0,>=5.5.0
Requires-Dist: huggingface-hub<2.0,>=1.5.0
Requires-Dist: sentence-transformers<6.0,>=5.3.0
Requires-Dist: modelscope<2.0,>=1.34.0
Requires-Dist: soundfile>=0.12.0
Requires-Dist: cryptography>=41.0
Requires-Dist: pyOpenSSL>=23.0
Requires-Dist: zeroconf>=0.140
Requires-Dist: mlx>=0.31.2
Requires-Dist: mlx-lm>=0.31.3
Requires-Dist: mlx-vlm>=0.5.0
Requires-Dist: mlx-audio>=0.4.3
Provides-Extra: coreml
Requires-Dist: coremltools>=7.0; extra == "coreml"
Requires-Dist: torch>=2.0; extra == "coreml"
Provides-Extra: all
Requires-Dist: edge-studio[coreml]; extra == "all"
Provides-Extra: dev
Requires-Dist: build>=1.2.0; extra == "dev"
Requires-Dist: pytest>=7.0.0; extra == "dev"
Dynamic: license-file

# Edge Studio

Edge Studio is AtomGradient's local workbench for building and testing
on-device AI products on Apple Silicon. It ships as a Python package with a
local Studio UI, an API server, and CLI workflows for model preparation, local
chat, and the Neural Imprint learning demo.

Start with the developer documentation when you are building an app or
integrating the SDK:

- Developer site: <https://atomgradient.github.io/edge-developers/>

## Install

Use Python 3.11 in an isolated environment before installing Edge Studio.

With `venv`:

```bash
python3.11 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install edge-studio
```

With `uv`:

```bash
uv venv --python 3.11 .venv
source .venv/bin/activate
uv pip install edge-studio
```

Current release candidate: `0.0.1rc1`.

For a deterministic RC install:

```bash
python -m pip install edge-studio==0.0.1rc1
```

The package installs one command-line entry point:

| Command | Use |
|---|---|
| `edge` | Launch Studio, prepare models, run local chat, inspect receipts, and try the learning demo. |

## Quick Start

```bash
python3.11 -m venv .venv
source .venv/bin/activate
python -m pip install edge-studio
edge studio
open http://127.0.0.1:18842
```

Edge Studio binds to `127.0.0.1:18842` by default. Override the host or port
with `VLM_HOST` and `VLM_PORT` when you need a different local address.

## First Model

The baseline developer-preview model is `qwen3.5-9b-4bit`.

```bash
edge models where qwen3.5-9b-4bit
edge models fetch qwen3.5-9b-4bit --source auto
```

`edge models fetch` supports ModelScope, Hugging Face, and hf-mirror sources.
The `auto` mode chooses a source order from the local network environment.

## First Chat

Run a local multi-turn chat after the model is available:

```bash
edge demo chat --model qwen3.5-9b-4bit --interactive
```

The first 9B model load can take tens of seconds. After `[chat:ready]`, ask a
few questions and exit with `/exit`.

## Learning Demo

Run the local correction-learning demo once the baseline model is ready:

```bash
edge demo learn run --model qwen3.5-9b-4bit
```

The demo exercises local receipts, correction capture, Neural Imprint artifact
generation, and a follow-up query without bundling internal evaluation data.

For the full walkthrough, SDK integration paths, and API references, use the
Edge Developers documentation:

- <https://atomgradient.github.io/edge-developers/docs/overview>

## Source Install

Use the source path when contributing to Edge Studio or testing a local checkout:

```bash
git clone https://github.com/AtomGradient/edge-studio.git
cd edge-studio
python3.11 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"
```

Launch the packaged UI/API server from the source checkout:

```bash
edge studio
open http://127.0.0.1:18842
```

For frontend development, run Vite separately and keep the backend server
running:

```bash
npm --prefix frontend ci
npm --prefix frontend run dev
edge studio
```

The Vite UI runs at `http://localhost:5173`; the backend stays on
`http://127.0.0.1:18842`.

## Build a Wheel

```bash
python -m pip install --upgrade build
./scripts/build_wheel.sh
```

The build script compiles the frontend and copies `frontend/dist` into package
resources before building the wheel, so users installing the wheel do not need
Node.js.

## Release Checks

```bash
python -m pytest tests -q
npm --prefix frontend run lint
npm --prefix frontend run build
python -m build
```

## License

Edge Studio is released under the MIT License. See `LICENSE`.
