From dbb0b7cb1f21c011ccb563129cf061d8e23823b3 Mon Sep 17 00:00:00 2001 From: hyperpolymath <6759885+hyperpolymath@users.noreply.github.com> Date: Thu, 25 Jun 2026 20:43:12 +0100 Subject: [PATCH] docs(readme): convert README.adoc -> Markdown README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit README must be real Markdown to render in GitHub community-health, the GitHub profile, and external MCP directories (Glama) — AsciiDoc shows as raw markup there. pandoc asciidoc->GFM, badges fixed to clickable, SPDX header kept as an HTML comment, duplicate README.adoc removed. Co-Authored-By: Claude Opus 4.8 --- README.adoc | 63 ---------------------------------------- README.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+), 63 deletions(-) delete mode 100644 README.adoc create mode 100644 README.md diff --git a/README.adoc b/README.adoc deleted file mode 100644 index c5ac9b3..0000000 --- a/README.adoc +++ /dev/null @@ -1,63 +0,0 @@ -// SPDX-License-Identifier: CC-BY-SA-4.0 -// Copyright (c) Jonathan D.A. Jewell -= LowLevel.jl -:toc: macro -:toclevels: 3 -:icons: font - -image:https://img.shields.io/badge/Project-Topology-9558B2[Topology,link="TOPOLOGY.md"] -image:https://img.shields.io/badge/Completion-85%25-green[85%,link="TOPOLOGY.md"] -image:https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=opensourcesecurity[OpenSSF Best Practices,link="https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/LowLevel.jl"] -image:https://img.shields.io/badge/License-MPL--2.0-blue.svg[License: PMPL-1.0] -image:https://api.thegreenwebfoundation.org/greencheckimage/github.com[Green Web,link="https://www.thegreenwebfoundation.org/green-web-check/?url=github.com"] -image:https://img.shields.io/badge/Status-Peak_System-red.svg[Peak System] - -*The Definitive Bare-Metal & Coprocessor Foundation for Julia.* - -toc::[] - -== Overview - -LowLevel.jl is not just a bridge; it is a **Resource-Aware Hardware Orchestrator**. It provides the Hyperpolymath ecosystem with deep-cycle diagnostics, self-healing fault tolerance, and native execution paths for every major processing unit in modern and future computing. - -It is designed for "High-Stakes Silicon"—where performance is non-negotiable and failure must be mathematically impossible. - -== Core Architectural Pillars - -=== 1. Universal Coprocessor Support (X-PU) -LowLevel.jl provides specialized kernels and dispatch logic for: -* **CPU**: Optimized for **Intel Core i9/Xeon** (AVX-512) and **AMD Ryzen 9/Pro** (Zen 4/5 extensions). -* **GPU**: Native hooks for NVIDIA (CUDA), AMD (ROCm), and Apple (Metal). -* **NPU/TPU**: Dedicated paths for Neural and Tensor units (Intel NPU, Google TPU). -* **QPU**: Quantum Processing Unit abstraction layer for hybrid classical-quantum algorithms. -* **PPU/MPU**: Physics and Mathematical Processing Units for high-fidelity simulations. -* **DSP/APU**: Digital Signal and Audio/Accelerated Processing Units. -* **IOPU**: Specialized I/O Processing for high-frequency data ingestion. - -=== 2. Resilience & Self-Healing -* **Diagnostics**: Real-time monitoring of thermal throttling, cache misses, and branch mispredictions. -* **Self-Healing**: Automated kernel hot-swapping. If an AVX-512 kernel triggers a hardware fault, the system transparently downgrades to a verified scalar fallback. -* **Fault-Tolerance**: Integration with Julia's task system to handle hardware-level MCE (Machine Check Exceptions) without crashing the runtime. - -=== 3. Resource Awareness -* **Topology Mapping**: Deep awareness of NUMA nodes, L1/L2/L3 cache boundaries, and memory bandwidth saturation. -* **Energy-Aware Computing**: Dynamic frequency scaling hooks to optimize for performance-per-watt during massive research simulations. - -== Project Structure - -[source,text] ----- -LowLevel.jl/ -├── src/ -│ ├── LowLevel.jl # Main Orchestrator -│ ├── hardware/ # Topology & Feature Detection -│ ├── accelerators/ # NPU, TPU, QPU, GPU modules -│ ├── resilience/ # Self-healing & Fault tolerance -│ ├── diagnostics/ # Telemetry & Performance monitoring -│ ├── asm/ # Multi-arch Assembly (x86, ARM, RISC-V) -│ └── zig/ # Safe systems logic -└── deps/ # Binary artifacts ----- - -== License -Palimpsest-MPL-1.0 License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..abae524 --- /dev/null +++ b/README.md @@ -0,0 +1,82 @@ + + +[![Topology](https://img.shields.io/badge/Project-Topology-9558B2)](TOPOLOGY.md) +[![85](https://img.shields.io/badge/Completion-85%25-green)](TOPOLOGY.md) [![OpenSSF Best Practices](https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=opensourcesecurity)](https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/LowLevel.jl) ![License: +PMPL-1.0](https://img.shields.io/badge/License-MPL--2.0-blue.svg) +![Peak System](https://img.shields.io/badge/Status-Peak_System-red.svg) + +**The Definitive Bare-Metal & Coprocessor Foundation for Julia.** + +
+ +
+ +# Overview + +LowLevel.jl is not just a bridge; it is a **Resource-Aware Hardware +Orchestrator**. It provides the Hyperpolymath ecosystem with deep-cycle +diagnostics, self-healing fault tolerance, and native execution paths +for every major processing unit in modern and future computing. + +It is designed for "High-Stakes Silicon"—where performance is +non-negotiable and failure must be mathematically impossible. + +# Core Architectural Pillars + +## 1. Universal Coprocessor Support (X-PU) + +LowLevel.jl provides specialized kernels and dispatch logic for: \* +**CPU**: Optimized for **Intel Core i9/Xeon** (AVX-512) and **AMD Ryzen +9/Pro** (Zen 4/5 extensions). \* **GPU**: Native hooks for NVIDIA +(CUDA), AMD (ROCm), and Apple (Metal). \* **NPU/TPU**: Dedicated paths +for Neural and Tensor units (Intel NPU, Google TPU). \* **QPU**: Quantum +Processing Unit abstraction layer for hybrid classical-quantum +algorithms. \* **PPU/MPU**: Physics and Mathematical Processing Units +for high-fidelity simulations. \* **DSP/APU**: Digital Signal and +Audio/Accelerated Processing Units. \* **IOPU**: Specialized I/O +Processing for high-frequency data ingestion. + +## 2. Resilience & Self-Healing + +- **Diagnostics**: Real-time monitoring of thermal throttling, cache + misses, and branch mispredictions. + +- **Self-Healing**: Automated kernel hot-swapping. If an AVX-512 kernel + triggers a hardware fault, the system transparently downgrades to a + verified scalar fallback. + +- **Fault-Tolerance**: Integration with Julia’s task system to handle + hardware-level MCE (Machine Check Exceptions) without crashing the + runtime. + +## 3. Resource Awareness + +- **Topology Mapping**: Deep awareness of NUMA nodes, L1/L2/L3 cache + boundaries, and memory bandwidth saturation. + +- **Energy-Aware Computing**: Dynamic frequency scaling hooks to + optimize for performance-per-watt during massive research simulations. + +# Project Structure + +```text +LowLevel.jl/ +├── src/ +│ ├── LowLevel.jl # Main Orchestrator +│ ├── hardware/ # Topology & Feature Detection +│ ├── accelerators/ # NPU, TPU, QPU, GPU modules +│ ├── resilience/ # Self-healing & Fault tolerance +│ ├── diagnostics/ # Telemetry & Performance monitoring +│ ├── asm/ # Multi-arch Assembly (x86, ARM, RISC-V) +│ └── zig/ # Safe systems logic +└── deps/ # Binary artifacts +``` + +# License + +Palimpsest-MPL-1.0 License.