Skip to content

Latest commit

 

History

History

docs

README.md

Documentation ownership and navigation

This map routes the maintained documentation for the checked-out source. Usage guides show how to call an interface, contracts specify admission and outputs, and the research program owns the objective, current question and chapters containing definitions, hypotheses and proofs. Its generated chapter index provides navigation.

Start with the root README for installation and an organized mathematical object, then use the example learning route and recovery-report guide to inspect its state, law, identity and response. Continue with the CLI/SDK object workflow or the regional workflows for the supported actions and observations. For their mathematical meaning, the theory index connects definitions and proofs to engine modules, tests and SDK entry points. Numerical evidence and conditional certificates retain the premises of their source objects; they are not empirical validation.

Choose the execution contract before following an example:

  • Native relational evolution: the joint execution guide and contract describe the argument-based law, held capacity and phase-domain checks.
  • Normalized-sine constructions and comparisons: the formed-object workflow and comparison contract retain their distinct smooth law. These observation, certificate and forecast APIs do not change the law executed by Network.step_relational. Alternative reciprocal mobilities have their own complete laws; shared storage does not transfer every theorem between them.
  • Operator words: CLI and SDK and event contracts cover registered operators, grammar and live admission. Word counts are not elapsed structural time.
  • Continuous nodal flow: API contracts and the architecture flow identify pressure, integrator, clock and source responsibilities. Held pressure, refreshed pressure and operator events have different execution semantics.

Use the regional workflow index to find an interface and the theory reading routes to assess its scientific claim. A captured state, supplied invariant family, finite enclosure and physical measurement have different source obligations. Common variables or storage do not join their theorems. The research program selects research work; an available guide does not authorize a campaign.

Usage guides

Maintained owner Use it for Boundary
CLI and SDK Organized-object entry points, requested operator studies, diagnostics, JSON and command routes Object identity and action admission belong to their models; word counts are not physical time
Research evidence and frozen source restoration Shared artifact admission, read-only audits and preparation of the declared source revision Restoration does not execute an experiment; archive integrity does not prove scientific premises
Regional and relational SDK Native joint evolution, separate sine assessments, regional observations and scoped certificates Preparations, references and uncertainty are inputs; captured states and declared exact families have different admission
Native relational execution and observations Argument-based field and finite-step execution, native tangents, prepared patterns and hypothetical support/state events. Euler steps retain numerical defects; hypothetical events do not change the live graph
Native relational capture, memory and continuous proofs Native capture and exclusions, cycle/contact memory, transit, reflected proofs, regularity and retained robustness evidence. Capture, transit and memory require their own domain, source and uncertainty premises
Shared observations, information and finite-sample bounds Regional and source-relative observations, exact linear and phase-moment information, finite-sample evidence and shared circular geometry. Observations retain unavailable cases and uncertainty; a projection need not close the dynamics
Normalized-sine comparison, inference and forecasts Shared sine-law report admission, captured comparison, retained mediation, sampling, hidden state/capacity inference and prior-only forecasting. The sine law is separate from native execution; inferred constraints need not identify full state
Sine response, constitutive comparisons and hidden memory Declared input/output resonance, bridge-law and clock discrimination, return-path geometry, causal hidden memory, autonomous pulses and recurrence distinctions. Input/output response, internal pulses and hidden memory have distinct complete-law hypotheses
Sine pattern geometry, formation and recovery Relative patterns and origins, composition, equilibrium and symmetry, prepared formation, recovery/capture, controlled slow references and budget exclusions. Prepared formation and recovery retain supplied support, inputs and source families
Conservative sine saddle preparations and certificates Signed-involution preparation, the C5/private-leaf saddle, directed passage, same-orbit retention, sensitivity, retained-metric forecasts and constitutive controls. Source and metric certificates do not select preparation or event occurrence
Conservative sine regional and collective dynamics Regional storage and currents, conservative winding acquisition and retention, compatible collective families, actual contact feedback and forecast-derived organization. Collective dynamics retains fine-state information and separates contact work from continuous loss
Retained sine pair state, identification and pulses Sufficient unordered/mixed pair state and cancellation inversion, capacities and support symmetry, pairing observations and windows, emission/transfer and doubled-C5 pulse response. Pair state and pulse certificates retain their support, capacity and preparation domains
Observational interfaces Feature graphs, multichannel signals, comparisons and reserved forecasts Engineering adapters do not independently identify canonical physical variables
Optional Torch backend Backend selection, device checks and execution limits Requested backend, effective device and measured acceleration are different claims

Contracts and diagnostics

Maintained owner Responsibility Primary evidence
API contracts Shared admission, nodal solvers and generated operator metadata Actual execution owners and operator registry
Relational dynamics Native field/step, separate sine-law reports, support budgets, uncertainty and forecast admission Exact continuous theorems, finite steps, validated enclosures and retained records have distinct guarantees
Native relational execution and observations Argument-based field and finite-step execution, native tangents, prepared patterns and hypothetical support/state events. Euler steps retain numerical defects; hypothetical events do not change the live graph
Native relational capture, memory and continuous proofs Native capture and exclusions, cycle/contact memory, transit, reflected proofs, regularity and retained robustness evidence. Capture, transit and memory require their own domain, source and uncertainty premises
Shared observations, information and finite-sample bounds Regional and source-relative observations, exact linear and phase-moment information, finite-sample evidence and shared circular geometry. Observations retain unavailable cases and uncertainty; a projection need not close the dynamics
Normalized-sine comparison, inference and forecasts Shared sine-law report admission, captured comparison, retained mediation, sampling, hidden state/capacity inference and prior-only forecasting. The sine law is separate from native execution; inferred constraints need not identify full state
Sine response, constitutive comparisons and hidden memory Declared input/output resonance, bridge-law and clock discrimination, return-path geometry, causal hidden memory, autonomous pulses and recurrence distinctions. Input/output response, internal pulses and hidden memory have distinct complete-law hypotheses
Sine pattern geometry, formation and recovery Relative patterns and origins, composition, equilibrium and symmetry, prepared formation, recovery/capture, controlled slow references and budget exclusions. Prepared formation and recovery retain supplied support, inputs and source families
Conservative sine saddle preparations and certificates Signed-involution preparation, the C5/private-leaf saddle, directed passage, same-orbit retention, sensitivity, retained-metric forecasts and constitutive controls. Source and metric certificates do not select preparation or event occurrence
Conservative sine regional and collective dynamics Regional storage and currents, conservative winding acquisition and retention, compatible collective families, actual contact feedback and forecast-derived organization. Collective dynamics retains fine-state information and separates contact work from continuous loss
Retained sine pair state, identification and pulses Sufficient unordered/mixed pair state and cancellation inversion, capacities and support symmetry, pairing observations and windows, emission/transfer and doubled-C5 pulse response. Pair state and pulse certificates retain their support, capacity and preparation domains
Operator events Schedules, jumps, atomic stages, REMESH and finite executor evidence Shared event and history owners; no unrestricted stability guarantee
Structural fields Tetrad definitions, units, availability and estimator provenance Shared field readers; the tetrad is not a complete state basis

Repository and research owners

Responsibility Primary owner
Contributor and agent instructions AGENTS, mirrored verbatim at .github/agents/my-agent.md
Package boundaries and execution paths Architecture
Test selection and development Testing, Contributing
CI, publication and reporting Workflows, Security
Documentation commands and staging Scripts
Definitions, derivations and scientific scope Theory catalog; glossary for classified concept cards
Grammar policies and verification Unified grammar; rules and evidence share that owner
Research objective, priorities and current state Research program, with the sole current question
Maintained runnable entry points Examples, benchmarks, basic arithmetic utility
Retained evidence and retirement provenance Archive; source-bound records remain separate from maintained contracts

Update rules

Change the implementation or definition and its owner together. Summaries link to that owner; they do not copy derivations, configuration tables or delivery histories. Keep usage examples separate from the full admission contract. The agent mirror is the only intentionally exact prose duplicate.

theory/RESEARCH_PROGRAM.md owns the objective and current question in a small entry document. Each linked chapter is a canonical Markdown file that can be opened and edited directly. theory/research_catalog.json supplies metadata for generated navigation. The compiled site reads these same sources; the optional scripts/research_book.py workflow is described in Contributing. Generated pages preserve paths, relative links and frozen proof associations. Old plan, strategy and portfolio routes are compact compatibility views, not active guidance.

Keep the research program within 96 KiB and each research chapter, program and maintained guide at most 4,000 physical lines. These limits are checked by scripts/check_documentation.py. Split chapters by model and responsibility. Put shared admission in its contract, proofs in their chapter, and examples in the matching guide. Preserve published routes and section aliases. Archived records and frozen evidence retain their own provenance and are outside this size guard.

The catalog above owns the technical website menu; the theory catalog owns its own menu. python scripts/check_documentation.py --write-generated refreshes both menus, the registry-derived operator table and the glossary index. The ordinary gate checks catalog coverage and generated agreement. Link/fragment checking and a strict site build also belong to the documentation checks. Generated consistency does not validate a theorem or a physical identification.

The glossary's declaration classes and dependency/evidence checks are specified by its own template and scripts/check_glossary.py. Do not redefine concept admission in another index or infer scientific proof from a valid link.

Evidence and generated material

docs/assets/ holds website support and referenced frozen research evidence, including source archives and numerical reports. Preserve those paths and bytes; new runs belong in artifacts/, not over the published record. An evidence record establishes only its declared scope and does not redefine a live API. Use retained-evidence checks and the instrument lifecycle to distinguish read-only audits from a separately declared new evaluation.

artifacts/, ignored output/, outputs/ and results/ retain local receipts and source contexts. They are not guides or another task queue. The documentation tools own source staging and the treatment of frozen source captures; maintained proofs and contracts remain checked. build/docs-source/ and site/ are generated; edit their maintained inputs.

Retire a document only after moving useful material to its owner and repairing maintained references. Preserve source-bound observations and mark their scope and replacement. Archive records explain supersession; manifests retain their original recovery paths and hashes. Unchanged committed material with verified Git recovery does not need another archive copy. Useful conditional results, counterexamples, uncommitted work and unique frozen evidence require preservation before removal.