Skip to content

Commit 56f2a98

Browse files
committed
fix: update test counts in documentation and tests to reflect current passing tests
1 parent eec8f35 commit 56f2a98

12 files changed

Lines changed: 29 additions & 21 deletions

File tree

bindings/python/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Native Python bindings for ArcadeDB - the multi-model database that supports Graph, Document, Key/Value, Search Engine, Time Series, and Vector models.
44

5-
**Status**: ✅ Production Ready | **Tests**: 262 Passing | **Platforms**: 4 Supported
5+
**Status**: ✅ Production Ready | **Tests**: 258 Passing | **Platforms**: 4 Supported
66

77
---
88

@@ -92,7 +92,7 @@ Import: `import arcadedb_embedded as arcadedb`
9292

9393
## 🧪 Testing
9494

95-
**Status**: 262 tests + example scripts passing on all 4 platforms
95+
**Status**: 258 tests + example scripts passing on all 4 platforms
9696

9797
```bash
9898
# Run all tests

bindings/python/docs/api/database.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -575,15 +575,16 @@ db.create_vector_index(
575575

576576
Create a vector index for similarity search (JVector implementation). Existing records are indexed automatically when the index is created.
577577

578-
**Parameters:**`
578+
**Parameters:**
579579

580580
- `vertex_type` (str): Vertex type containing vectors
581581
- `vector_property` (str): Property storing vector arrays
582582
- `dimensions` (int): Vector dimensionality
583583
- `distance_function` (str): `"cosine"`, `"euclidean"`, or `"inner_product"`
584584
- `max_connections` (int): Max connections per node (default: 16). Maps to `maxConnections` in HNSW (JVector).
585585
- `beam_width` (int): Beam width for search/construction (default: 100). Maps to `beamWidth` in HNSW (JVector).
586-
- `quantization` (str | None): `"INT8"`, `"BINARY"`, `"PRODUCT"` for PQ, or `None` for full precision (default: `"INT8"`).
586+
- `quantization` (str | None): `"INT8"` (recommended), `"BINARY"`, `"PRODUCT"` for PQ, or `None` for full precision (default: `"INT8"`).
587+
Prefer `"INT8"` for current production usage in these bindings; `"PRODUCT"`/PQ is currently not recommended for production workloads.
587588
- `location_cache_size` (int | None): Override location cache size (default: `None`, uses engine default).
588589
- `graph_build_cache_size` (int | None): Override graph build cache size (default: `None`, uses engine default).
589590
- `mutations_before_rebuild` (int | None): Override rebuild threshold (default: `None`, uses engine default).

bindings/python/docs/api/vector.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,9 @@ db.create_vector_index(
147147
- Maps to `beamWidth` in JVector
148148
- Higher = better recall, slower search
149149
- Typical range: 50-500
150-
- `quantization` (str | None): `"INT8"`, `"BINARY"`, `"PRODUCT"`, or `None` (default: `"INT8"`)
150+
- `quantization` (str | None): `"INT8"` (recommended), `"BINARY"`, `"PRODUCT"`, or `None` (default: `"INT8"`)
151+
- Prefer `"INT8"` for current production usage in these bindings.
152+
- `"PRODUCT"`/PQ is available but currently not recommended for production workloads.
151153

152154
**Returns:**
153155

bindings/python/docs/development/build-architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This document describes the build architecture for creating platform-specific Py
1919

2020
**All supported platforms:**
2121

22-
-262 tests passing
22+
-258 tests passing
2323
- ✅ 31.7M JARs (83 files, identical across platforms)
2424
- ✅ All native runners (no QEMU emulation)
2525
- ✅ Reproducible builds (pinned runner versions)

bindings/python/docs/development/ci-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,11 @@ After a successful release, you should see:
9999

100100
### Test Results (CI run #96)
101101

102-
All 4 platforms passing 262 tests and example scripts:
102+
All 4 platforms passing 258 tests and example scripts:
103103

104104
| Platforms | Wheel Size | JRE Size | Tests |
105105
|-----------|-----------|----------|-------|
106-
| linux/amd64, linux/arm64, darwin/arm64, windows/amd64 | ~68M | ~60M | 262 passed ✅ |
106+
| linux/amd64, linux/arm64, darwin/arm64, windows/amd64 | ~68M | ~60M | 258 passed ✅ |
107107

108108
**All platforms include:**
109109

bindings/python/docs/development/testing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
Comprehensive testing documentation for ArcadeDB Python bindings.
44

55
!!! success "Test Coverage"
6-
**262 tests** across 20 test files, 100% passing
6+
**258 tests** across 20 test files, 100% passing
77

8-
- **Current package**: 262 passed
8+
- **Current package**: 258 passed
99
- All ArcadeDB features working (SQL, OpenCypher, Studio)
1010

1111
## Quick Navigation

bindings/python/docs/development/testing/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The ArcadeDB Python bindings have a comprehensive test suite covering all major
55
## Quick Statistics
66

77
!!! success "Test Results"
8-
- **Current package**: ✅ 262 passed
8+
- **Current package**: ✅ 258 passed
99
- All features available (SQL, OpenCypher, Studio UI, Vector search)
1010

1111
## What's Tested
@@ -129,7 +129,7 @@ pytest -m "not slow"
129129
When all tests pass, you should see:
130130

131131
```
132-
======================== 262 passed in 9.67s =========================
132+
======================== 258 passed in 9.67s =========================
133133
```
134134

135135

bindings/python/docs/getting-started/distributions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Pre-built **platform-specific** wheels are available for **4 platforms**. Sizes
3434
- ✅ All platforms use **platform-specific wheels** (not universal)
3535
- ✅ uv pip automatically selects the correct wheel for your system
3636
- ✅ Each platform has its own bundled JRE optimized for that architecture
37-
- ✅ All supported platforms tested and verified (262/262 tests passing)
37+
- ✅ All supported platforms tested and verified (258/258 tests passing)
3838
- ✅ Built on native runners (no emulation) for optimal performance
3939

4040
## What's Included
@@ -56,7 +56,7 @@ Pre-built **platform-specific** wheels are available for **4 platforms**. Sizes
5656

5757
## Test Results
5858

59-
**262 out of 262 tests pass** on all platforms (100% success rate):
59+
**258 out of 258 tests pass** on all platforms (100% success rate):
6060

6161
- ✅ All core database operations
6262
- ✅ SQL and OpenCypher queries

bindings/python/docs/guide/vectors.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,12 +140,13 @@ rids = [row.get_rid() for row in db.query("sql", "SELECT @rid FROM Doc WHERE top
140140
results = index.find_nearest(query_vec, k=5, allowed_rids=rids)
141141
```
142142

143-
## Quantization (Experimental)
143+
## Quantization
144144

145145
- `quantization` accepts `"INT8"`, `"BINARY"`, `"PRODUCT"` (PQ), or `None` (full precision).
146-
- Default is `"INT8"`; set `quantization=None` for full-precision vectors.
146+
- Default and recommended setting is `"INT8"`.
147+
- Use `quantization=None` only when you explicitly need full-precision vectors and can accept higher memory usage.
147148
- PQ tunables (require `quantization="PRODUCT"`): `pq_subspaces` (M), `pq_clusters` (K), `pq_center_globally`, `pq_training_limit`.
148-
- INT8/BINARY have shown instability on larger inserts; PQ is the recommended quantization path for recall/latency trade-offs.
149+
- `"PRODUCT"`/PQ is currently not recommended for production workloads in these bindings.
149150

150151
## SQL Helpers (Optional)
151152

@@ -155,7 +156,7 @@ results = index.find_nearest(query_vec, k=5, allowed_rids=rids)
155156
- `SELECT vectorNeighbors('Doc[embedding]', [0.1,0.2], 5) AS res`
156157
- Or with type/property signature: `SELECT vectorNeighbors('Doc', 'embedding', [0.1,0.2], 5)`
157158
- Math/distance helpers: `vectorCosineSimilarity`, `vectorL2Distance`, `vectorDotProduct`, `vectorNormalize`, `vectorAdd`, `vectorSum`, etc.
158-
- Quantization via SQL: `METADATA {"quantization": "INT8"}` works for tiny datasets; larger inserts still unstable (see tests).
159+
- Quantization via SQL: `METADATA {"quantization": "INT8"}` is the recommended path for embedded usage.
159160

160161
## Examples & References
161162

bindings/python/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
Native Python bindings for ArcadeDB with full test coverage
1010

1111
- **Status**: ✅ Production Ready
12-
- **Tests**: ✅ 262 + 7 Examples Passing
12+
- **Tests**: ✅ 258 + 7 Examples Passing
1313

1414
- :fontawesome-brands-python:{ .lg .middle } **Pure Python API**
1515

0 commit comments

Comments
 (0)