You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/deployment_matrix.md
+11Lines changed: 11 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,7 @@ Use this page to choose the shortest deployment path for a product, demo, benchm
9
9
| Colab notebook | Browser smoke tests, first evaluation, shareable demos |[Colab quickstart](../examples/colab/)| No local setup; first run downloads model files, GPU runtime is faster. |
10
10
| Python API | Notebooks, offline jobs, first model evaluation |[README quick start](../README.md#quick-start)| Lowest ceremony; caller owns batching, retries, and files. |
11
11
| OpenAI-compatible API | Private speech API, agents, Dify/LangChain/AutoGen-style clients |[OpenAI API example](../examples/openai_api/)| Easiest integration for apps that already support OpenAI audio APIs. |
12
+
| Xinference | Teams that already operate Xinference model serving |[Xinference repository](https://github.com/xorbitsai/inference)| Use a Xinference version containing [xorbitsai/inference#5140](https://github.com/xorbitsai/inference/pull/5140) so Fun-ASR-Nano uses packaged `funasr~=1.3.0` instead of the old pinned git commit. |
12
13
| Docker Compose API | Reproducible local smoke test or small internal service |[OpenAI API Docker docs](../examples/openai_api/#docker-deployment)| CPU by default; adapt the image before using CUDA in containers. |
13
14
| Kubernetes API | Internal speech API for cluster services |[Kubernetes template](../examples/openai_api/kubernetes/)| Starts as private `ClusterIP`; add auth, TLS, network policy, and GPU scheduling before broader exposure. |
14
15
| Runtime WebSocket service | Live captions, meetings, call-center streams |[Runtime service docs](../runtime/readme.md)| Use when partial results, endpointing, or long-lived audio streams matter. |
@@ -28,6 +29,16 @@ Use the [Colab quickstart](../examples/colab/) when you want a browser-only smok
28
29
29
30
Use the OpenAI-compatible API. It exposes `/v1/audio/transcriptions`, `/v1/models`, `/health`, and Swagger docs. Start with `sensevoice`, run `examples/openai_api/smoke_test.sh` or `examples/openai_api/smoke_test.py`, then connect existing SDK or HTTP clients using [client recipes](../examples/openai_api/CLIENTS.md) and [JavaScript/TypeScript recipes](../examples/openai_api/JAVASCRIPT.md). For browser upload or microphone demos, use the [Gradio browser demo](../examples/openai_api/GRADIO.md). For Dify, n8n, HTTP nodes, or webhook workers, follow the [workflow recipes](../examples/openai_api/WORKFLOWS.md). For API gateways, developer portals, and schema-driven imports, use the [OpenAPI spec](../examples/openai_api/OPENAPI.md). Before sharing the service, review the [security and gateway guide](../examples/openai_api/SECURITY.md).
30
31
32
+
### I already run Xinference
33
+
34
+
Use Xinference when your stack already standardizes on its model registry,
35
+
virtualenv isolation, and serving lifecycle. Make sure your Xinference build
36
+
includes [xorbitsai/inference#5140](https://github.com/xorbitsai/inference/pull/5140);
37
+
that update moved the Fun-ASR-Nano model specs from an old FunASR git SHA to the
38
+
packaged `funasr~=1.3.0` dependency line. For first-time FunASR evaluation or
39
+
agent-oriented OpenAI-compatible transcription, start with the native FunASR
40
+
OpenAI API example above instead.
41
+
31
42
### I want a repeatable container demo
32
43
33
44
Use `examples/openai_api/docker-compose.yml` for a CPU-mode smoke test:
| Docker Compose API | 可复现本地 smoke test 或小型内部服务 |[OpenAI API Docker 文档](../examples/openai_api/README_zh.md)| 默认 CPU;容器里使用 CUDA 前需要先适配 CUDA-capable 镜像。 |
13
14
| Kubernetes API | 集群内私有语音 API |[Kubernetes 模板](../examples/openai_api/kubernetes/README_zh.md)| 默认私有 `ClusterIP`;对外开放前补齐鉴权、TLS、网络策略和 GPU 调度。 |
0 commit comments