Repository navigation
Docs in sync with release-v0.2: prune removed features, current names - #85
Merged
Merged
Conversation
…fields, counter-based initializer rng Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- configuration.md: one Benchmark settings section (config.yaml defaults, pydantic validation, env parsing); config.yaml header comment matches config.py - runtime.md: drop the empty-backend default (runtime.backend is a Literal) - protocol.md: a control setup is named by the comparison (control_setups is gone) - plotting.md, token_accounting.md, prompts.md: drop DEFAULT_BASELINE, MIN_TOKEN_FOLD, prompt_hash and the prompts table - translator desugarings, library requests, measurement statistics, hidden_tests README, python-to-numpy skill, CONTRIBUTING, HF export: current names Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…re-launch check, config.yaml comment names Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Synchronizes the docs on
release-v0.2with the code that ships. Docs, comments and one YAML header only; no code behaviour changes. Merged withorigin/release-v0.2(incl. "Prune checks": no remaining mention ofcheck_manifest_structure.py,check_large_files.py,check_reference_naming.py,run_smoke.shor enroot).Removed (text describing features that are gone)
docs/configuration.md: the duplicate "Benchmark settings (config.yaml)" section (config.coerce,config.settings(),config.get(key, default), "keys are not validated", "reader's default"). One section remains.docs/runtime.md: the emptyruntime.backend-> podman default andcontainers.DEFAULT_BACKEND(the key is aLiteralnow).docs/extending/protocol.md:control_setupsinstudies.yaml.docs/plotting.md: theDEFAULT_BASELINEfallback (population.one_denominatorrefuses a slice with no denominator).docs/token_accounting.md: theepisodes.MIN_TOKEN_FOLDgate.docs/prompts.md:prompt_hash, thepromptstable and__<variant>filenames.docs/requests_api.md: "old envelope fields refused naming the new spelling" (Submissionrefuses every undeclared field).CONTRIBUTING.md: the manifest-structure hook in the hook list; "or hint" (hints are gone).hpcagent_bench/config.yamlcomments:"" = podman.Renamed (stale names -> current)
docs/translator_desugarings_and_tool_bugs.md:frontend._inline_module_constants,lowering._EnumerateZipRewriter,_MethodCallRewriter,_lp_normalize_index_access,_fix_real_scalar_dtypes,lib_nodes._retarget_scalar_accumulator,numpy_desugar._OuterBroadcastPeel,lib_nodes (_remap)-> the public names (lib_nodes.padedge_clamp).hpcagent_bench/docs/library_requests.md:sandbox.DISTRIBUTED_CONTRACT_LIBRARIES->grading.distributed_libraries/sandbox.distributed_contract_libraries.docs/measurement_statistics.md:seeds.secret_first->hidden_seeds.secret_seed_first.helpers/skills/python-to-numpy/SKILL.md:UNGATED_SUBTRACKS->UNGATED_TAGS.hpcagent_bench/harness/hidden_tests/README.md:context.py(gone).CONTRIBUTING.md:prompts/sections/lang/->prompts/lang/.docs/extending/packets.md: example classCpfTool->CpfToolCpu;docs/writing_an_agent.md,docs/prompts.md: the CPF tool/source packets by their device keys.hpcagent_bench/config.yamlcomments:envs/display_names.yaml->@llmkeys ofmodels.py;task.host_only_setup->task.setup_declared_host_only.Rewritten (current behaviour, briefly)
docs/configuration.md"Benchmark settings":config.yamlis the only place a default is written, validated by the pydantic models ofconfig.py; resolution order; env parsing by type (config.parse_env); unknown keys/env names are errors.config.yaml's header comment says the same.docs/requests_api.mdaction table: which operations lower withstartup.grid(distribute,replicate,split/block/permuteand inverses,place) and which run on one node only (pad,shuffle,linear_shuffle,zip,unzip), instead of "parsed, refused".docs/extending/benchmark.mdinitializer:rngis aCounterGenerator(not anumpy.random.Generator); a GPU grade builds its inputs on the device withxp = cupy, bit-identical to the host, so elementary functions and floating reductions come fromsupport/exact_math.py.docs/extending/packets.md: the four CPF keys (cpf-cpu-src,cpf-gpu-src,cpf-tool-cpu,cpf-tool-gpu) stated once;cpf-src/cpf-toolare the device-neutral aliasespackets.by_deviceresolves.docs/hf_dataset_and_harbor.md: the HF export runs in thecoveragejob (there is nohf-exportstep).CONTRIBUTING.md,experiments/LAUNCH.md:pytest -m smoke(tests/test_smoke.py) is the pre-launch check on the login node.docs/extending/skills-and-tools.md:applies.explicit, and the frontmatter is the pydanticpackets.SkillFrontmatter/Applies(unknown keys refused).CONTRIBUTING.md: acompilers.yamlblock is alanguages.CompilerBlock.No doc file was removed: none covers only removed features.
Checks
sphinx-build -W --keep-going -b html docspasses;helpers/scripts/checks/check_doc_links.pypasses.pre-commit run --files <changed>green.test_docs_match_code,test_protocol_samples,test_skill_content,test_check_no_corpus_leak,test_skill_triggers,test_skill_packet_leaks,test_skill_applies,test_prompt_skills,test_experiments,test_config,test_cluster_prompt_sources,test_check_repo_rules,test_packets,test_vocabulary) pass.test_cpf_pages_vocabularyfails locally only because the local venv's dace is not the f97160b pin (SEQUENTIAL_ON_CPUmissing); the CPF pages were not touched.Left as is (needs a decision)
hpcagent_bench/support/update_names.pyand its doc lines (docs/extending/optimizer.md,columns.py) still ship: the framework/canon DB names stamp uses it. Not pruned.docs/code_reuse.mdis a consolidation audit pinned to old commits (proposal rows, line numbers at934c5b98d); kept, not refreshed.docs/observations.mdblank meanings "recorded before the stamp/column" describe rows a freshhb-results-v1.0DB may no longer produce; kept.🤖 Generated with Claude Code