Skip to content

Docs: say when to turn on the JVM AOT cache, with measured figures - #248

Merged
tae898 merged 2 commits into
mainfrom
docs/jvm-aot-cache
Nov 4, 2026
Merged

tae898 merged 2 commits into
mainfrom
docs/jvm-aot-cache

Conversation

@tae898

@tae898 tae898 commented Nov 4, 2026

Copy link
Copy Markdown
Collaborator

Closes #247

Adds a section to the installation page, "Faster start-up with the AOT cache" (#jvm-aot), and links it from the start-up row of which-package.adoc and from the container list. It names the opt-in as the code has it (ARCADEDB_AOT=1 or start_jvm(aot=True), with ARCADEDB_AOT_CACHE=<file> for the file), says what the cache does, when to turn it on (short-lived processes where start-up dominates) and when not to bother (long-running services), the one-time costs (a training run, a check run and a cache file of about 40 MiB), and the measured figures with 95% intervals, stated as one laptop study on JDK 25 with the study's workload. It makes no speed promise beyond those figures.

The cache stays off by default because the timed study's pre-written rule was not met: the first script is faster with the cache, but the 300,000-row insert_many interval ended at 1.036 against a bar of 1.03, and no steady figure showed a gain we can rely on.

The figures, the pair and round counts and the one-time costs are written into the page by a script that reads the study's score output; none is typed by hand. The script also asserts the claims the prose makes about the intervals (the control arm includes 1, the 2-hop interval ends below 1, the others include 1). Docs only: no change in src or tests. The Docs workflow (Antora, a warning fails it) is the check for this pull request.

🤖 Generated with Claude Code

tae898 and others added 2 commits November 4, 2026 10:38
…loses #247)

The timed A/B kept the AOT cache opt-in: the first script is faster
(0.653, 95% interval [0.648, 0.658]) but no steady figure gains, and the
300k-row insert interval ended at 1.036 against a 1.03 bar. By the study's
rule the cache is documented, not made the default. Figures are generated
from the study's score.out by script.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ng run

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tae898
tae898 merged commit 3dfdf68 into main Nov 4, 2026
1 check passed
@tae898
tae898 deleted the docs/jvm-aot-cache branch November 4, 2026 01:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: say when to turn on the JVM AOT cache (opt-in, with measured figures)

1 participant