Skip to content

Commit dbaf9fe

Browse files
Initial commit: qwen3-asr-api
Pure OpenAI-compatible STT wrapper for Qwen3-ASR. Adds entrypoint to official qwenllm/qwen3-asr image for auto-start, env-based model switching, and Unraid template.
0 parents  commit dbaf9fe

9 files changed

Lines changed: 409 additions & 0 deletions

File tree

.dockerignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.git/
2+
.github/
3+
.gitignore
4+
*.md
5+
templates/
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Build and Publish Docker Image
2+
3+
on:
4+
push:
5+
branches: [main]
6+
tags: ["v*"]
7+
pull_request:
8+
branches: [main]
9+
10+
env:
11+
REGISTRY: ghcr.io
12+
IMAGE_NAME: ${{ github.repository }}
13+
14+
jobs:
15+
build-and-push:
16+
runs-on: ubuntu-latest
17+
permissions:
18+
contents: read
19+
packages: write
20+
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
25+
- name: Set up Docker Buildx
26+
uses: docker/setup-buildx-action@v3
27+
28+
- name: Login to GHCR
29+
if: github.event_name != 'pull_request'
30+
uses: docker/login-action@v3
31+
with:
32+
registry: ${{ env.REGISTRY }}
33+
username: ${{ github.actor }}
34+
password: ${{ secrets.GITHUB_TOKEN }}
35+
36+
- name: Extract metadata
37+
id: meta
38+
uses: docker/metadata-action@v5
39+
with:
40+
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
41+
tags: |
42+
type=ref,event=branch
43+
type=semver,pattern={{version}}
44+
type=sha
45+
type=raw,value=latest,enable={{is_default_branch}}
46+
47+
- name: Build and push
48+
uses: docker/build-push-action@v6
49+
with:
50+
context: .
51+
file: Dockerfile
52+
push: ${{ github.event_name != 'pull_request' }}
53+
tags: ${{ steps.meta.outputs.tags }}
54+
labels: ${{ steps.meta.outputs.labels }}
55+
cache-from: type=gha
56+
cache-to: type=gha,mode=max

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
models/
2+
.env

Dockerfile

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
FROM qwenllm/qwen3-asr:latest
2+
3+
COPY entrypoint.sh /entrypoint.sh
4+
RUN chmod +x /entrypoint.sh
5+
6+
ENV MODEL_ID=Qwen/Qwen3-ASR-0.6B \
7+
HOST=0.0.0.0 \
8+
PORT=80 \
9+
GPU_MEMORY_UTILIZATION=0.8
10+
11+
EXPOSE 80
12+
13+
HEALTHCHECK --interval=30s --timeout=10s --start-period=120s --retries=3 \
14+
CMD curl -sf http://localhost:${PORT}/health || exit 1
15+
16+
ENTRYPOINT ["/entrypoint.sh"]

LICENSE

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work.
38+
39+
"Derivative Works" shall mean any work, whether in Source or Object
40+
form, that is based on (or derived from) the Work and for which the
41+
editorial revisions, annotations, elaborations, or other modifications
42+
represent, as a whole, an original work of authorship. For the purposes
43+
of this License, Derivative Works shall not include works that remain
44+
separable from, or merely link (or bind by name) to the interfaces of,
45+
the Work and Derivative Works thereof.
46+
47+
"Contribution" shall mean any work of authorship, including
48+
the original version of the Work and any modifications or additions
49+
to that Work or Derivative Works thereof, that is intentionally
50+
submitted to the Licensor for inclusion in the Work by the copyright owner
51+
or by an individual or Legal Entity authorized to submit on behalf of
52+
the copyright owner. For the purposes of this definition, "submitted"
53+
means any form of electronic, verbal, or written communication sent
54+
to the Licensor or its representatives, including but not limited to
55+
communication on electronic mailing lists, source code control systems,
56+
and issue tracking systems that are managed by, or on behalf of, the
57+
Licensor for the purpose of discussing and improving the Work, but
58+
excluding communication that is conspicuously marked or otherwise
59+
designated in writing by the copyright owner as "Not a Contribution."
60+
61+
"Contributor" shall mean Licensor and any individual or Legal Entity
62+
on behalf of whom a Contribution has been received by the Licensor and
63+
subsequently incorporated within the Work.
64+
65+
2. Grant of Copyright License. Subject to the terms and conditions of
66+
this License, each Contributor hereby grants to You a perpetual,
67+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
68+
copyright license to reproduce, prepare Derivative Works of,
69+
publicly display, publicly perform, sublicense, and distribute the
70+
Work and such Derivative Works in Source or Object form.
71+
72+
3. Grant of Patent License. Subject to the terms and conditions of
73+
this License, each Contributor hereby grants to You a perpetual,
74+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
75+
(except as stated in this section) patent license to make, have made,
76+
use, offer to sell, sell, import, and otherwise transfer the Work,
77+
where such license applies only to those patent claims licensable
78+
by such Contributor that are necessarily infringed by their
79+
Contribution(s) alone or by combination of their Contribution(s)
80+
with the Work to which such Contribution(s) was submitted. If You
81+
institute patent litigation against any entity (including a
82+
cross-claim or counterclaim in a lawsuit) alleging that the Work
83+
or a Contribution incorporated within the Work constitutes direct
84+
or contributory patent infringement, then any patent licenses
85+
granted to You under this License for that Work shall terminate
86+
as of the date such litigation is filed.
87+
88+
4. Redistribution. You may reproduce and distribute copies of the
89+
Work or Derivative Works thereof in any medium, with or without
90+
modifications, and in Source or Object form, provided that You
91+
meet the following conditions:
92+
93+
(a) You must give any other recipients of the Work or
94+
Derivative Works a copy of this License; and
95+
96+
(b) You must cause any modified files to carry prominent notices
97+
stating that You changed the files; and
98+
99+
(c) You must retain, in the Source form of any Derivative Works
100+
that You distribute, all copyright, patent, trademark, and
101+
attribution notices from the Source form of the Work,
102+
excluding those notices that do not pertain to any part of
103+
the Derivative Works; and
104+
105+
(d) If the Work includes a "NOTICE" text file as part of its
106+
distribution, then any Derivative Works that You distribute must
107+
include a readable copy of the attribution notices contained
108+
within such NOTICE file, excluding any notices that do not
109+
pertain to any part of the Derivative Works, in at least one
110+
of the following places: within a NOTICE text file distributed
111+
as part of the Derivative Works; within the Source form or
112+
documentation, if provided along with the Derivative Works; or,
113+
within a display generated by the Derivative Works, if and
114+
wherever such third-party notices normally appear. The contents
115+
of the NOTICE file are for informational purposes only and
116+
do not modify the License. You may add Your own attribution
117+
notices within Derivative Works that You distribute, alongside
118+
or as an addendum to the NOTICE text from the Work, provided
119+
that such additional attribution notices cannot be construed
120+
as modifying the License.
121+
122+
You may add Your own copyright statement to Your modifications and
123+
may provide additional or different license terms and conditions
124+
for use, reproduction, or distribution of Your modifications, or
125+
for any such Derivative Works as a whole, provided Your use,
126+
reproduction, and distribution of the Work otherwise complies with
127+
the conditions stated in this License.
128+
129+
5. Submission of Contributions. Unless You explicitly state otherwise,
130+
any Contribution intentionally submitted for inclusion in the Work
131+
by You to the Licensor shall be under the terms and conditions of
132+
this License, without any additional terms or conditions.
133+
Notwithstanding the above, nothing herein shall supersede or modify
134+
the terms of any separate license agreement you may have executed
135+
with Licensor regarding such Contributions.
136+
137+
6. Trademarks. This License does not grant permission to use the trade
138+
names, trademarks, service marks, or product names of the Licensor,
139+
except as required for reasonable and customary use in describing the
140+
origin of the Work and reproducing the content of the NOTICE file.
141+
142+
7. Disclaimer of Warranty. Unless required by applicable law or
143+
agreed to in writing, Licensor provides the Work (and each
144+
Contributor provides its Contributions) on an "AS IS" BASIS,
145+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
146+
implied, including, without limitation, any warranties or conditions
147+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
148+
PARTICULAR PURPOSE. You are solely responsible for determining the
149+
appropriateness of using or redistributing the Work and assume any
150+
risks associated with Your exercise of permissions under this License.
151+
152+
8. Limitation of Liability. In no event and under no legal theory,
153+
whether in tort (including negligence), contract, or otherwise,
154+
unless required by applicable law (such as deliberate and grossly
155+
negligent acts) or agreed to in writing, shall any Contributor be
156+
liable to You for damages, including any direct, indirect, special,
157+
incidental, or consequential damages of any character arising as a
158+
result of this License or out of the use or inability to use the
159+
Work (including but not limited to damages for loss of goodwill,
160+
work stoppage, computer failure or malfunction, or any and all
161+
other commercial damages or losses), even if such Contributor
162+
has been advised of the possibility of such damages.
163+
164+
9. Accepting Warranty or Additional Liability. While redistributing
165+
the Work or Derivative Works thereof, You may choose to offer,
166+
and charge a fee for, acceptance of support, warranty, indemnity,
167+
or other liability obligations and/or rights consistent with this
168+
License. However, in accepting such obligations, You may act only
169+
on Your own behalf and on Your sole responsibility, not on behalf
170+
of any other Contributor, and only if You agree to indemnify,
171+
defend, and hold each Contributor harmless for any liability
172+
incurred by, or claims asserted against, such Contributor by reason
173+
of your accepting any such warranty or additional liability.
174+
175+
END OF TERMS AND CONDITIONS
176+
177+
Copyright 2024 Qwen Team, Alibaba Group
178+
179+
Licensed under the Apache License, Version 2.0 (the "License");
180+
you may not use this file except in compliance with the License.
181+
You may obtain a copy of the License at
182+
183+
http://www.apache.org/licenses/LICENSE-2.0
184+
185+
Unless required by applicable law or agreed to in writing, software
186+
distributed under the License is distributed on an "AS IS" BASIS,
187+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
188+
See the License for the specific language governing permissions and
189+
limitations under the License.

README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# qwen3-asr-api
2+
3+
Pure OpenAI-compatible Speech-to-Text API powered by [Qwen3-ASR](https://github.com/QwenLM/Qwen3-ASR).
4+
5+
No extra services, no NGINX, no voiceprint database — just the model served via vLLM with an OpenAI-compatible endpoint.
6+
7+
## What this adds
8+
9+
The official `qwenllm/qwen3-asr` Docker image has no entrypoint (drops to interactive shell). This wrapper adds:
10+
- Auto-start `qwen-asr-serve` on container launch
11+
- Environment variable for model switching (no rebuild needed)
12+
- GPU memory control via env var
13+
- Unraid Community Applications template
14+
15+
## Quick Start
16+
17+
```bash
18+
docker run -d --gpus all --shm-size=4g \
19+
-p 8000:80 \
20+
-v /path/to/models:/root/.cache/huggingface \
21+
-e MODEL_ID=Qwen/Qwen3-ASR-0.6B \
22+
ghcr.io/hsiang-han/qwen3-asr-api:latest
23+
```
24+
25+
First start downloads the model (~1-3GB depending on variant).
26+
27+
## Usage (OpenAI-compatible)
28+
29+
```bash
30+
curl -X POST http://localhost:8000/v1/audio/transcriptions \
31+
-H "Content-Type: multipart/form-data" \
32+
-F "file=@audio.wav" \
33+
-F "model=qwen3-asr"
34+
```
35+
36+
Or with OpenAI SDK:
37+
```python
38+
from openai import OpenAI
39+
client = OpenAI(base_url="http://localhost:8000/v1", api_key="none")
40+
result = client.audio.transcriptions.create(
41+
model="qwen3-asr",
42+
file=open("audio.wav", "rb")
43+
)
44+
print(result.text)
45+
```
46+
47+
## Model Options
48+
49+
| Model | VRAM | Speed | Best for |
50+
|-------|------|-------|----------|
51+
| `Qwen/Qwen3-ASR-0.6B` | ~2-3GB | RTFx 166 | Low latency, shared GPU |
52+
| `Qwen/Qwen3-ASR-1.7B` | ~4-6GB | RTFx 148 | Best accuracy |
53+
54+
Switch by changing `MODEL_ID` env var and restarting container.
55+
56+
## Unraid Install
57+
58+
1. Add template repo: `https://github.com/hsiang-han/unraid_templates`
59+
2. Find "qwen3-asr-api" in Community Applications
60+
3. Configure MODEL_ID and GPU settings
61+
4. Start — first launch downloads model, subsequent starts are fast
62+
63+
## Environment Variables
64+
65+
| Variable | Default | Description |
66+
|----------|---------|-------------|
67+
| `MODEL_ID` | `Qwen/Qwen3-ASR-0.6B` | Model to serve |
68+
| `GPU_MEMORY_UTILIZATION` | `0.8` | GPU memory fraction (0.0-1.0) |
69+
| `HOST` | `0.0.0.0` | Bind address |
70+
| `PORT` | `80` | Container port |
71+
72+
## License
73+
74+
Apache-2.0 (same as upstream Qwen3-ASR)

docker-compose.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: qwen3-asr-api
2+
services:
3+
qwen3-asr-api:
4+
image: ghcr.io/hsiang-han/qwen3-asr-api:latest
5+
container_name: qwen3-asr-api
6+
build:
7+
context: .
8+
dockerfile: Dockerfile
9+
ports:
10+
- "8000:80"
11+
volumes:
12+
- /mnt/user/appdata/qwen3-asr-api/models:/root/.cache/huggingface
13+
environment:
14+
- MODEL_ID=Qwen/Qwen3-ASR-0.6B
15+
- GPU_MEMORY_UTILIZATION=0.8
16+
shm_size: "4gb"
17+
deploy:
18+
resources:
19+
reservations:
20+
devices:
21+
- driver: nvidia
22+
count: 1
23+
capabilities: [gpu]
24+
restart: unless-stopped

entrypoint.sh

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#!/bin/bash
2+
set -e
3+
4+
echo "=== qwen3-asr-api ==="
5+
echo "Model: ${MODEL_ID}"
6+
echo "Port: ${PORT}"
7+
echo "GPU Memory: ${GPU_MEMORY_UTILIZATION}"
8+
echo "====================="
9+
10+
exec qwen-asr-serve "${MODEL_ID}" \
11+
--host "${HOST}" \
12+
--port "${PORT}" \
13+
--gpu-memory-utilization "${GPU_MEMORY_UTILIZATION}"

0 commit comments

Comments
 (0)