Repository navigation
docs: add a Vectors how-to page - #119
Merged
Merged
Conversation
The page covers what is specific to the bindings: SQL and openCypher first, then create_vector_index, find_nearest (allowed_rids), get_stats, build_graph_now and warm_up; the different quantization and addHierarchy defaults of the statement and the method; NumPy arrays and lists as vectors; mutations_before_rebuild as a floor. tests/test_docs_vectors_page.py runs every Python block in page order against one fresh database and compares each block's output with the text block under it. Closes #118. Part of #19. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…le PRODUCT advice This package starts at 26.11.1 and ships its own engine, so "needs 26.10.1 / 26.11.1 or later" can never be false for a reader. The "PRODUCT is not recommended; see #10514" advice (docstring, repeated on the page) points at an issue upstream closed on 2026-10-21; the open cost is #10847 (every graph rebuild retrains the codebook and re-encodes every vector), stated as a fact with "measure on your data" instead of a recommendation. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
8 of 10 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the "Vectors" how-to page (
docs/modules/ROOT/pages/how-to/vectors.adoc), with a nav entry and the README "Documentation" sentence updated.The page is SQL and openCypher first (
CREATE INDEX ... LSM_VECTOR,vectorNeighbors,db.index.vector.queryNodes) and documents the Python wrappers where no statement does the job or Python adds something:create_vector_index,find_nearestwithallowed_rids,get_stats(),build_graph_now(),warm_up(), NumPy arrays and lists as vectors,insert_manyandinsert_columnswith vectors. It states the different defaults of the statement and the method (quantizationNONEagainstINT8,addHierarchyfalseagainstTrue), that both build the graph at creation, and thatmutations_before_rebuildis a floor (the ratio is in the Database settings section of Databases and queries, linked, not repeated). It has no numbers: the old guide's recall and timing tables were measured on 26.10.x wheels and are left out. Behavior afterREBUILD INDEXfor a held wrapper is not documented (#117 is not merged).tests/test_docs_vectors_page.pyextracts every Python block of the page, runs them in page order in one namespace against one freshtemp_db, and compares each block's output with the[source,text]block under it. It uses no Java object, so it runs on both packages. The Docs workflow builds the page, and a warning fails it. Links into the main manual are{arcadedb-docs-url}/<page>and each target returned 200.I did not run the tests or Antora on my side (CI does), so the expected outputs on the page are the first thing to check if a leg is red.
Closes #118. Part of #19.
🤖 Generated with Claude Code