docs(evaluate): fix conformance CLI, defaults, optimizer imports - #2018
Conversation
✅ Deploy Preview for adk-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
a10ba6a to
11a424e
Compare
That is not correct. For the ADK Docs all Gemini model names we use the "gemini-flash-latest" to minimize the need for future updates just based on model versions and releases |
Technical review reportVerified PR #2018 against Every substantive claim in the PR is technically correct. Highlights:
Four non-blocking nits are in the report: the PR leaves |
removing repetitive (and soon out of date) default model declarations.
joefernandez
left a comment
There was a problem hiding this comment.
Technical review completed. Approved with minor updates.
Corrections to the evaluation pages and the prompt-optimization page: a CLI subcommand that does not exist, an import that does not resolve, wrong defaults, and a few claims that did not match runtime behavior.
Changes
docs/evaluate/index.md—adk conformance createis not a subcommand; the recording command isadk conformance record <path> <streaming-mode>, and the trailing mode argument is required (documentednone/sse,bidiunsupported). Thespec.yamlexample was mangled onto one line with keys the loader does not read (name,expected_tools); replaced with a validyaml-fenced example usingdescription/agent/user_messages. Also:adk evalaccepts eval set ids as well as file paths (not mixed in one command),rubric_based_multi_turn_trajectory_quality_v1was missing from the criteria list, and the user-simulation exclusion list was inverted — the unsupported criteria aretool_trajectory_avg_score,response_match_scoreandfinal_response_match_v2.docs/optimize/index.md—from google.adk.optimization import SimplePromptOptimizer, SimplePromptOptimizerConfigdoes not resolve; import fromgoogle.adk.optimization.simple_prompt_optimizer.num_iterationsandbatch_sizewere listed as required but default to10and5; added the missingoptimizer_modelandmodel_configurationrows; noted that both GEPA optimizers are experimental and warn on construction.docs/evaluate/environment_simulation.md,docs/evaluate/user-sim.md,docs/optimize/index.md— the documented default model is"gemini-2.5-flash", not"gemini-flash-latest".docs/evaluate/user-sim.md— added the undocumentedinclude_function_callsfield (defaults tofalse) and themax_allowed_invocationsdetails: the initial fixed prompt counts as an invocation,-1means no limit.docs/evaluate/criteria.md— the twoEvalConfigJSON snippets were not valid JSON (mis-nested braces, trailing comma); reindented and fixed. The rubric note saidRubricBasedEvaluatorasserts a non-empty list at init; it raisesValueErrorat evaluation time, and the criterion-level list may be empty when eval cases supply type-matching rubrics.How this was produced
Part of a page-by-page audit of the Python docs against the
google/adk-pythonv2.5.0 source: every import resolved against a real 2.5.0 install, every constructor kwarg checked againstmodel_fields/inspect.signature, every documented default read off the field. A second independent pass re-derived each claim from source rather than trusting the finding, and a third conformed the new wording to the surrounding pages.mkdocs build --strictis clean.Only Python tabs and language-neutral prose were touched — this audit had no ground truth for the Go / Java / TypeScript SDKs.
Split out of a larger audit branch so each area can be reviewed on its own.