Skip to content

Commit dae3f2f

Browse files
committed
docs: update docs for stable release - Production/Stable status, complete CHANGELOG, accurate README and AGENTS.md
1 parent 3770fe8 commit dae3f2f

4 files changed

Lines changed: 56 additions & 27 deletions

File tree

AGENTS.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ mise run fix # ruff check --fix + ruff format
3333
### Pytest Configuration
3434

3535
- `testpaths = ["tests"]`, `pythonpath = ["."]`
36-
- Integration marker: `@pytest.mark.integration` (requires ~1.2 GB model download)
36+
- Integration marker: `@pytest.mark.integration` (requires model downloads: ONNX ~1.2 GB, Q4F16 ~1 GB, GGUF ~756 MB)
37+
- Integration test files: `test_integration.py` (ONNX), `test_integration_q4f16.py`, `test_integration_gguf.py`
3738
- CI runs: `uv run pytest -m "not integration" --tb=short`
3839

3940
## Code Style
@@ -53,7 +54,10 @@ mise run fix # ruff check --fix + ruff format
5354

5455
### Type Checker (ty)
5556

56-
Uses defaults (no custom config in pyproject.toml).
57+
Custom rules in `[tool.ty.rules]` (pyproject.toml):
58+
- `unresolved-import = "warn"` (llama_cpp is optional)
59+
- `possibly-missing-attribute = "warn"` (onnxruntime incomplete stubs)
60+
- `invalid-argument-type = "warn"`, `unresolved-attribute = "warn"`, `not-subscriptable = "warn"`, `invalid-assignment = "warn"`, `call-non-callable = "warn"`
5761

5862
### Import Ordering (isort via Ruff)
5963

CHANGELOG.md

Lines changed: 44 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,81 @@
11
# Changelog
22

3-
## [0.2.1](https://github.com/n24q02m/qwen3-embed/compare/v0.2.0...v0.2.1) (2026-02-14)
4-
3+
## [1.2.0](https://github.com/n24q02m/qwen3-embed/compare/v1.1.3...v1.2.0) (2026-03-04)
54

65
### Features
76

8-
* promote dev to main (v0.2.1-beta) ([#5](https://github.com/n24q02m/qwen3-embed/issues/5)) ([8d8dbc1](https://github.com/n24q02m/qwen3-embed/commit/8d8dbc12ce60aec6b68b3c85ca5146b43de18f80))
7+
* migrate to 2025-2026 tech stack (uv/ty) ([7b689e4](https://github.com/n24q02m/qwen3-embed/commit/7b689e4))
8+
* add Codecov coverage upload ([891201b](https://github.com/n24q02m/qwen3-embed/commit/891201b))
9+
* add Renovate for automated dependency updates ([4e307b4](https://github.com/n24q02m/qwen3-embed/commit/4e307b4))
10+
* add comprehensive test coverage for utilities and components ([f1d2997](https://github.com/n24q02m/qwen3-embed/commit/f1d2997))
911

10-
## [0.2.1-beta](https://github.com/n24q02m/qwen3-embed/compare/v0.2.0...v0.2.1-beta) (2026-02-14)
12+
### Bug Fixes
1113

14+
* make TextCrossEncoder.add_custom_model case-insensitive ([#88](https://github.com/n24q02m/qwen3-embed/issues/88)) ([30212f0](https://github.com/n24q02m/qwen3-embed/commit/30212f0))
15+
* fix path traversal and DoS risk ([#118](https://github.com/n24q02m/qwen3-embed/issues/118)) ([1bf8a49](https://github.com/n24q02m/qwen3-embed/commit/1bf8a49))
16+
* increase test coverage to 92% and resolve typing errors ([7658adf](https://github.com/n24q02m/qwen3-embed/commit/7658adf))
1217

13-
### Features
18+
## [1.1.3](https://github.com/n24q02m/qwen3-embed/compare/v1.1.2...v1.1.3) (2026-02-28)
19+
20+
### Bug Fixes
21+
22+
* correct model identifiers from Qwen/ to n24q02m/ namespace ([298405c](https://github.com/n24q02m/qwen3-embed/commit/298405c))
1423

15-
* add Q4F16 ONNX and GGUF model variant support ([8cc81c0](https://github.com/n24q02m/qwen3-embed/commit/8cc81c0ed10a3968758ba252dbc948aedc16cab1))
24+
## [1.1.2](https://github.com/n24q02m/qwen3-embed/compare/v1.1.1...v1.1.2) (2026-02-27)
25+
26+
### Bug Fixes
27+
28+
* GGUF Reranker Device.AUTO defaulting to CPU instead of GPU ([684af12](https://github.com/n24q02m/qwen3-embed/commit/684af12))
29+
30+
## [1.1.1](https://github.com/n24q02m/qwen3-embed/compare/v1.1.0...v1.1.1) (2026-02-25)
31+
32+
### Bug Fixes
1633

34+
* auto-detect GPU for GGUF backend (Device.AUTO uses n_gpu=-1) ([edb58bb](https://github.com/n24q02m/qwen3-embed/commit/edb58bb))
1735

1836
### Documentation
1937

20-
* update README with Q4F16 and GGUF variants ([c17f975](https://github.com/n24q02m/qwen3-embed/commit/c17f97541d579bda276b7138ed650deb1e7561d3))
38+
* add GPU acceleration section and fix CPU-only claim ([add0204](https://github.com/n24q02m/qwen3-embed/commit/add0204))
2139

22-
## [0.2.0](https://github.com/n24q02m/qwen3-embed/compare/v0.1.0...v0.2.0) (2026-02-13)
40+
## [1.1.0](https://github.com/n24q02m/qwen3-embed/compare/v1.0.0...v1.1.0) (2026-02-22)
2341

42+
### Features
2443

25-
### ⚠ BREAKING CHANGES
44+
* auto-detect DirectML GPU provider and improve logging ([f400012](https://github.com/n24q02m/qwen3-embed/commit/f400012))
45+
46+
## [1.0.0](https://github.com/n24q02m/qwen3-embed/compare/v0.2.1...v1.0.0) (2026-02-18)
47+
48+
### Chores
49+
50+
* migrate from release-please to python-semantic-release v10 ([9a78411](https://github.com/n24q02m/qwen3-embed/commit/9a78411))
2651

27-
* Package import changed from 'from fastembed import ...' to 'from qwen3_embed import ...'. The PyPI package name remains qwen3-embed.
52+
## [0.2.1](https://github.com/n24q02m/qwen3-embed/compare/v0.2.0...v0.2.1) (2026-02-14)
2853

2954
### Features
3055

31-
* promote dev to main (v0.2.0-beta) ([#2](https://github.com/n24q02m/qwen3-embed/issues/2)) ([4c95738](https://github.com/n24q02m/qwen3-embed/commit/4c95738222df7ae0ea339dc07d2a56d973e0365b))
32-
* qwen3-embed v0.1.0 - trimmed fastembed fork for Qwen3 models only ([d2a53fc](https://github.com/n24q02m/qwen3-embed/commit/d2a53fce71b55c44071717bd6722bcaf6fbcef7a))
56+
* add Q4F16 ONNX and GGUF model variant support ([8cc81c0](https://github.com/n24q02m/qwen3-embed/commit/8cc81c0))
57+
58+
### Documentation
3359

34-
## [0.2.0-beta](https://github.com/n24q02m/qwen3-embed/compare/v0.1.0...v0.2.0-beta) (2026-02-13)
60+
* update README with Q4F16 and GGUF variants ([c17f975](https://github.com/n24q02m/qwen3-embed/commit/c17f975))
3561

62+
## [0.2.0](https://github.com/n24q02m/qwen3-embed/compare/v0.1.0...v0.2.0) (2026-02-13)
3663

3764
### ⚠ BREAKING CHANGES
3865

39-
* Package import changed from 'from fastembed import ...' to 'from qwen3_embed import ...'. The PyPI package name remains qwen3-embed.
66+
* Package import changed from `from fastembed import ...` to `from qwen3_embed import ...`. The PyPI package name remains `qwen3-embed`.
4067

4168
### Features
4269

43-
* qwen3-embed v0.1.0 - trimmed fastembed fork for Qwen3 models only ([d2a53fc](https://github.com/n24q02m/qwen3-embed/commit/d2a53fce71b55c44071717bd6722bcaf6fbcef7a))
44-
70+
* qwen3-embed v0.1.0 - trimmed fastembed fork for Qwen3 models only ([d2a53fc](https://github.com/n24q02m/qwen3-embed/commit/d2a53fc))
4571

4672
### Bug Fixes
4773

48-
* port ONNX compatibility fixes and add integration tests ([59e30d0](https://github.com/n24q02m/qwen3-embed/commit/59e30d00138668921763592d357ea68efb0decc1))
49-
* resolve CI lint failures and exclude integration tests from CI ([a645d52](https://github.com/n24q02m/qwen3-embed/commit/a645d524a3f0b322e62fad3baf758995c19decc9))
50-
74+
* port ONNX compatibility fixes and add integration tests ([59e30d0](https://github.com/n24q02m/qwen3-embed/commit/59e30d0))
5175

5276
### Code Refactoring
5377

54-
* rename package from fastembed to qwen3_embed ([6e77ba5](https://github.com/n24q02m/qwen3-embed/commit/6e77ba5715d48e33fe8bb863a135e17b2a385a1a))
78+
* rename package from fastembed to qwen3_embed ([6e77ba5](https://github.com/n24q02m/qwen3-embed/commit/6e77ba5))
5579

5680
## 0.1.0 (2026-02-13)
5781

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Qwen3 Embed
22

3-
**Lightweight Qwen3 text embedding and reranking via ONNX Runtime**
3+
**Lightweight Qwen3 text embedding and reranking via ONNX Runtime and GGUF**
44

55
[![CI](https://github.com/n24q02m/qwen3-embed/actions/workflows/ci.yml/badge.svg)](https://github.com/n24q02m/qwen3-embed/actions/workflows/ci.yml)
66
[![codecov](https://codecov.io/gh/n24q02m/qwen3-embed/graph/badge.svg?token=M038M651L2)](https://codecov.io/gh/n24q02m/qwen3-embed)
@@ -148,7 +148,8 @@ model = TextEmbedding(model_name="n24q02m/Qwen3-Embedding-0.6B-ONNX", cuda=Devic
148148

149149
### GGUF
150150

151-
GPU is handled by `llama-cpp-python`. Install with CUDA support:
151+
GPU is handled by `llama-cpp-python`. The default `pip install qwen3-embed[gguf]` is CPU-only.
152+
For CUDA GPU support, build with:
152153

153154
```bash
154155
CMAKE_ARGS="-DGGML_CUDA=on" pip install qwen3-embed[gguf]
@@ -175,7 +176,6 @@ mise run fix # ruff auto-fix + format
175176

176177
## Related Projects
177178

178-
- **[modalcom-ai-workers](https://github.com/n24q02m/modalcom-ai-workers)** — GPU-accelerated AI workers on Modal.com using this embedding model
179179
- **[mnemo-mcp](https://github.com/n24q02m/mnemo-mcp)** — MCP memory server with semantic search powered by qwen3-embed
180180
- **[wet-mcp](https://github.com/n24q02m/wet-mcp)** — MCP web search server with vector-based docs search
181181

pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
[project]
22
name = "qwen3-embed"
33
version = "1.2.0"
4-
description = "Lightweight Qwen3 text embedding & reranking via ONNX Runtime (fork of fastembed)"
4+
description = "Lightweight Qwen3 text embedding & reranking via ONNX Runtime and GGUF (fork of fastembed)"
55
readme = "README.md"
66
license = "Apache-2.0"
77
requires-python = ">=3.13"
88
authors = [{ name = "n24q02m" }]
99
keywords = ["vector", "embedding", "reranking", "qwen3", "onnx", "onnxruntime"]
1010
classifiers = [
11-
"Development Status :: 3 - Alpha",
11+
"Development Status :: 5 - Production/Stable",
1212
"Intended Audience :: Developers",
1313
"License :: OSI Approved :: Apache Software License",
14+
"Programming Language :: Python :: 3",
1415
"Programming Language :: Python :: 3.13",
1516
"Topic :: Scientific/Engineering :: Artificial Intelligence",
1617
]

0 commit comments

Comments
 (0)