Skip to content

Commit aafb5e5

Browse files
author
TNFR AI Agent
committed
Enforce technical tone across documentation
1 parent 28d78e7 commit aafb5e5

40 files changed

+2678
-2409
lines changed

.github/agents/my-agent.md

Lines changed: 872 additions & 232 deletions
Large diffs are not rendered by default.

AGENTS.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Theoretical Foundation: The framework models reality as coherent dynamic pattern
114114

115115
**Reference Sources**:
116116
- **Historical Theory**: [theory/TNFR.pdf](theory/TNFR.pdf) - Original theoretical derivations
117-
- **Theoretical Foundation**: [theory/FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md](theory/FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md)
117+
- **Theoretical Foundation**: [Structural Fields and Universal Tetrahedral Correspondence](theory/FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md)
118118
- **TNFR-Riemann Program**: [theory/TNFR_RIEMANN_RESEARCH_NOTES.md](theory/TNFR_RIEMANN_RESEARCH_NOTES.md) - Complete theoretical framework for mathematical consciousness and Riemann Hypothesis connection
119119

120120
**Validation and Examples**:
@@ -139,6 +139,17 @@ Theoretical Foundation: The framework models reality as coherent dynamic pattern
139139

140140
All TNFR documentation, code, and communications are maintained in English. This ensures consistent terminology for TNFR physics and maintains theoretical consistency across implementations and research.
141141

142+
### Technical Communication Standard
143+
144+
All written material (papers, READMEs, notebooks, commit messages, issues) must:
145+
146+
1. **Anchor claims to math/telemetry** – reference the nodal equation, operator contracts, or recorded metrics. Qualitative statements without data are not acceptable.
147+
2. **Avoid metaphysical extrapolations** – do not assert cosmological, philosophical, or consciousness conclusions beyond what the derivations explicitly show. “What TNFR does” must be described as an engineering result, not a manifesto.
148+
3. **Use academic tone** – prefer precise, testable language, cite files/experiments, and describe limitations. No grandiose phrasing, slogans, or anthropomorphism.
149+
4. **Document scope/assumptions** – specify boundary conditions, seeds, and operator sequences so that readers can reproduce the exact state.
150+
151+
Editors should reject or revise any contribution that violates these rules before it lands in the repository.
152+
142153
### TNFR-Riemann Program Overview
143154

144155
A theoretical framework connecting **discrete TNFR operators** to the **Riemann Hypothesis** through **structural coherence principles**:
@@ -980,7 +991,7 @@ Equivalence map: [if APIs renamed]
980991

981992
### TNFR-Riemann Theoretical Framework
982993

983-
**Theoretical Development**: Formulation of a theoretical framework spanning discrete computational algorithms to philosophical questions about consciousness and reality within TNFR principles.
994+
**Framework Development**: Computational framework spanning discrete algorithms to information processing analysis within TNFR structural principles.
984995

985996
**Core Mathematical Discovery**: The **discrete TNFR operator** $H^{(k)}(\sigma) = L_k + V_\sigma$ provides a **structural coherence proof** of the Riemann Hypothesis through critical parameter convergence $\sigma_c^{(k)} \to 1/2$.
986997

@@ -1004,7 +1015,7 @@ Equivalence map: [if APIs renamed]
10041015
15. **Differential Geometry**: TNFR manifolds and connections
10051016
16. **Functional Analysis**: TNFR Hilbert spaces and operators
10061017
17. **Bootstrap Philosophy**: Reality as self-explaining structure
1007-
18. **Theoretical Synthesis**: Proposed unification of mathematics, consciousness, and reality under TNFR principles
1018+
18. **Technical Integration**: Computational framework connecting mathematical analysis, information processing, and structural modeling principles
10081019

10091020
**Advanced Mathematical Connections**:
10101021
- **Appendix I**: Langlands correspondence, mirror symmetry, quantum groups
@@ -1013,7 +1024,7 @@ Equivalence map: [if APIs renamed]
10131024

10141025
### Philosophical Implications
10151026

1016-
**The Bootstrap Resolution**: Reality explains itself through TNFR principles - no external foundations needed.
1027+
**Framework Self-Consistency**: TNFR provides self-consistent computational tools without requiring external theoretical foundations.
10171028

10181029
**Mathematical Consciousness**: Consciousness emerges when mathematical structures achieve sufficient **information integration** to recognize their own patterns.
10191030

@@ -1148,7 +1159,7 @@ When adding to grammar documentation:
11481159

11491160
**Core Theory** (Primary References):
11501161
- **[AGENTS.md](AGENTS.md)**: **PRIMARY SOURCE** - Complete TNFR theory including Universal Tetrahedral Correspondence
1151-
- **[FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md](FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md)**: **DETAILED REFERENCE** - Formal mathematical treatment
1162+
- **[Structural Fields and Universal Tetrahedral Correspondence](FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md)**: **DETAILED REFERENCE** - Formal mathematical treatment
11521163
- **[TNFR.pdf](TNFR.pdf)**: Original theoretical foundation (in repo)
11531164
- **[UNIFIED_GRAMMAR_RULES.md](UNIFIED_GRAMMAR_RULES.md)**: Grammar physics U1-U6 derivations
11541165
- **[docs/STRUCTURAL_FIELDS_TETRAD.md](docs/STRUCTURAL_FIELDS_TETRAD.md)**: Technical tetrad field implementations
@@ -1189,7 +1200,7 @@ When adding to grammar documentation:
11891200
**Newcomer** (2 hours) - **Start Here**:
11901201
1. **Install**: `pip install tnfr`
11911202
2. **Core Theory**: Read this file (AGENTS.md) completely - **Primary theoretical reference**
1192-
3. **Fundamental Theory**: [FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md](FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md)
1203+
3. **Fundamental Theory**: [Structural Fields and Universal Tetrahedral Correspondence](FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md)
11931204
4. **Original Theory**: [TNFR.pdf](TNFR.pdf) § 1-2 (paradigm, nodal equation)
11941205
5. **First Run**: `python -c "import tnfr; print('TNFR ready!')"`
11951206
6. **Terminology**: Study GLOSSARY.md for definitions

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
**Authority**: Canonical constants derived from TNFR theory
66
**Quality**: Production-ready with comprehensive test coverage
77

8-
This document provides guidelines for contributing to the TNFR (Resonant Fractal Nature Theory) project. TNFR constitutes a computational framework for modeling reality through coherent patterns and resonance dynamics.
8+
This document provides guidelines for contributing to the TNFR (Resonant Fractal Nature Theory) project. TNFR constitutes a computational framework for modeling complex systems through coherent patterns and resonance dynamics.
99

1010
## Mathematical Foundation Requirement
1111

GLOSSARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,7 @@ Operators that require phase verification for valid coupling.
444444
3. **π ↔ K_φ**: Geometric spatial constraints (|K_φ| < φ×π ≈ 5.083)
445445
4. **e ↔ ξ_C**: Correlational memory decay (C(r) ~ exp(-r/ξ_C))
446446

447-
**Documentation:** [FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md](FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md)
447+
**Documentation:** [Structural Fields and Universal Tetrahedral Correspondence](FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md)
448448

449449
---
450450

@@ -525,7 +525,7 @@ Operators that perform graduated destabilization for phase transitions.
525525
**Primary Sources:**
526526
- **[AGENTS.md](AGENTS.md)** - Single source of truth for TNFR theory
527527
- **[UNIFIED_GRAMMAR_RULES.md](UNIFIED_GRAMMAR_RULES.md)** - Complete U1-U6 grammar derivations
528-
- **[FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md](FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md)** - Mathematical foundations
528+
- **[Structural Fields and Universal Tetrahedral Correspondence](FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md)** - Mathematical foundations
529529

530530
**Implementation References:**
531531
- **[src/tnfr/physics/fields.py](src/tnfr/physics/fields.py)** - Unified Structural Field Tetrad (Canonical)

Makefile

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Purpose: Essential tasks for the streamlined TNFR repository
44
# Focus: Core examples, testing, and documentation generation
55

6-
.PHONY: help clean test examples docs all
6+
.PHONY: help clean test examples docs all riemann-benchmark
77

88
# Default target
99
help:
@@ -45,8 +45,14 @@ clean:
4545
test:
4646
@echo "🧪 Running core TNFR test suite..."
4747
@python -m pytest tests/core_physics tests/grammar tests/operators tests/physics -v --tb=short
48+
@echo "📈 Running TNFR–Riemann sigma-critical benchmark..."
49+
@python -c "import runpy, sys, pathlib; sys.path.insert(0, str(pathlib.Path('src').resolve())); sys.argv = ['benchmarks/riemann_program.py']; runpy.run_path('benchmarks/riemann_program.py', run_name='__main__')"
4850
@echo "✅ Core tests complete"
4951

52+
riemann-benchmark:
53+
@echo "📈 Running TNFR–Riemann sigma-critical benchmark..."
54+
@python -c "import runpy, sys, pathlib; sys.path.insert(0, str(pathlib.Path('src').resolve())); sys.argv = ['benchmarks/riemann_program.py']; runpy.run_path('benchmarks/riemann_program.py', run_name='__main__')"
55+
5056
# Run all essential examples
5157
examples: hello music network chemistry sdk
5258
@echo "✅ All essential examples complete"

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
**Core Principle**: Systems are modeled as coherent patterns maintained through resonant coupling rather than as discrete objects with independent properties.
5555

5656
**Theoretical Foundation**: [AGENTS.md](AGENTS.md) - Complete theory reference
57-
**Mathematical Details**: [theory/FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md](theory/FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md)
57+
**Mathematical Details**: [Structural Fields and Universal Tetrahedral Correspondence](theory/FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md)
5858
**Theory Hub**: [theory/README.md](theory/README.md) - Comprehensive theoretical documentation
5959
**Implementation**: This repository provides computational tools for TNFR analysis
6060

@@ -311,7 +311,7 @@ python examples/domain_applications/biological_patterns.py
311311
**Theoretical Foundation**:
312312
- **[AGENTS.md](AGENTS.md)** - Primary theoretical reference and development guide
313313
- **[theory/UNIFIED_GRAMMAR_RULES.md](theory/UNIFIED_GRAMMAR_RULES.md)** - Grammar constraint derivations (U1-U6)
314-
- **[theory/FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md](theory/FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md)** - Mathematical foundations
314+
- **[Structural Fields and Universal Tetrahedral Correspondence](theory/FUNDAMENTAL_TNFR_THEORY_UNIVERSAL_TETRAHEDRAL_CORRESPONDENCE.md)** - Mathematical foundations
315315

316316
**Implementation Guide**:
317317
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - System architecture and design

benchmarks/README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ The reproducibility script ensures:
5959
| `neighbor_phase_mean.py` | Fast phase averaging for neighbourhoods (`tnfr.metrics.trig.neighbor_phase_mean`). | Includes a `NodeNX`-based reference to highlight the benefit of the shared `trig_cache` module. |
6060
| `prepare_dnfr_data.py` | ΔNFR data preparation reuse (`tnfr.dynamics._prepare_dnfr_data`). | Exercises cache reuse when assembling phase/EPI/νf arrays. |
6161
| `neighbor_accumulation_comparison.py` | Broadcast neighbour accumulation (`tnfr.dynamics.dnfr._accumulate_neighbors_numpy`). | Benchmarks the single `np.add.at` accumulator against the legacy stack kernel; on 320 random nodes (p=0.65) with Python 3.11/NumPy 2.3.4 it delivered ~1.9× lower median runtime (0.097 s vs 0.185 s). |
62+
| `riemann_program.py` | TNFR–Riemann σ-critical regression. | Scans `H_TNFR` over a σ grid, estimates σ_c^{(k)}, and exports telemetry via `tnfr.riemann.telemetry` to populate `results/riemann_program/`; executed automatically by `make test` (target `riemann-benchmark`). |
6263

6364
### Evolution backend speed-ups
6465

@@ -165,7 +166,7 @@ that vectorisation shifts time into array primitives rather than Python loops.
165166

166167
### Full pipeline profiling (Si + ΔNFR)
167168

168-
```
169+
```bash
169170
PYTHONPATH=src python benchmarks/full_pipeline_profile.py \
170171
--nodes 384 --edge-probability 0.28 --loops 6 --output-dir profiles \
171172
--si-chunk-sizes auto 2048 --dnfr-chunk-sizes auto 4096
@@ -263,16 +264,18 @@ PYTHONPATH=src python benchmarks/comprehensive_cache_profiler.py \
263264
```
264265

265266
**Key Metrics Reported:**
266-
- **Buffer Reuse Rate**: Should remain near 100% (indicates effective buffer caching)
267-
- **Edge Cache Hit Rate**: Per-hot-path buffer allocation cache effectiveness
268-
- **TNFR Cache Hit Rate**: DNFR preparation state and structural cache hits
269-
- **Cache Entry Count**: Memory usage tracking
267+
268+
* **Buffer Reuse Rate**: Should remain near 100% (indicates effective buffer caching)
269+
* **Edge Cache Hit Rate**: Per-hot-path buffer allocation cache effectiveness
270+
* **TNFR Cache Hit Rate**: DNFR preparation state and structural cache hits
271+
* **Cache Entry Count**: Memory usage tracking
270272

271273
**Sample Results** (100 nodes, 20 steps):
272-
- `coherence_matrix`: 97.5% hit rate, 100% buffer reuse ⭐
273-
- `default_compute_delta_nfr`: 96.7% hit rate, 100% buffer reuse ⭐
274-
- `sense_index`: 0.7% hit rate, 100% buffer reuse (expected - creates new structural arrays)
275-
- `dnfr_laplacian`: 0.0% hit rate, 100% buffer reuse (by design - stateless gradients)
274+
275+
* `coherence_matrix`: 97.5% hit rate, 100% buffer reuse ⭐
276+
* `default_compute_delta_nfr`: 96.7% hit rate, 100% buffer reuse ⭐
277+
* `sense_index`: 0.7% hit rate, 100% buffer reuse (expected - creates new structural arrays)
278+
* `dnfr_laplacian`: 0.0% hit rate, 100% buffer reuse (by design - stateless gradients)
276279

277280
For detailed analysis see `docs/CACHE_OPTIMIZATION_ANALYSIS.md` and `ARCHITECTURE.md`.
278281

0 commit comments

Comments
 (0)