Skip to content

Commit d8d5b70

Browse files
mivertowskiclaude
andcommitted
docs: remove all WebGPU/Metal/WGSL references from documentation
v1.0.0 docs cleanup: Deleted: - docs/14-wgpu-codegen.md (WGSL transpiler doc — crate removed) - docs/PRODUCTION_READINESS_ROADMAP.md (superseded by v1.0.0 plan) Updated 12 docs: - 02-crate-structure: remove 4 crate entries, dependency sections - 05-gpu-backends: remove Metal (~70 lines) and WebGPU (~65 lines) sections - 09-testing: remove wgpu-codegen and wavesim3d test counts - 15-showcase-applications: remove WaveSim3D, update to 4 apps - 16-cli-tool: CUDA-only codegen examples - README index: remove WebGPU/Metal from backend table - 03/04/07/08/10/13: targeted removal of backend references Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 546b0d9 commit d8d5b70

14 files changed

Lines changed: 34 additions & 1392 deletions

docs/02-crate-structure.md

Lines changed: 2 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -60,25 +60,17 @@ RustCompute/
6060
│ │ └── tests/
6161
│ │ └── gpu_execution_verify.rs # GPU execution verification
6262
│ │
63-
│ ├── ringkernel-metal/ # Metal backend (scaffolded)
64-
│ │ └── src/lib.rs
65-
│ │
66-
│ ├── ringkernel-wgpu/ # WebGPU backend (scaffolded)
67-
│ │ └── src/lib.rs
68-
│ │
6963
│ ├── ringkernel-codegen/ # Kernel code generation
7064
│ │ └── src/lib.rs
7165
│ │
72-
│ ├── ringkernel-ir/ # Unified IR for multi-backend codegen
66+
│ ├── ringkernel-ir/ # Unified IR for codegen
7367
│ │ └── src/
7468
│ │ ├── lib.rs # IrModule, IrBuilder, ValueId, BlockId
7569
│ │ ├── builder.rs # Fluent IR construction
7670
│ │ ├── nodes.rs # IR node types (BinaryOp, Load, Store, etc.)
7771
│ │ ├── types.rs # IrType, ScalarType, VectorType
7872
│ │ ├── optimize.rs # Optimization passes (DCE, constant folding)
7973
│ │ ├── lower_cuda.rs # CUDA backend lowering
80-
│ │ ├── lower_wgsl.rs # WGSL backend lowering
81-
│ │ ├── lower_msl.rs # MSL backend lowering
8274
│ │ └── validation.rs # IR validation
8375
│ │
8476
│ ├── ringkernel-cli/ # CLI tool for scaffolding and codegen
@@ -136,14 +128,6 @@ RustCompute/
136128
│ │ ├── simulation/ # Grid, kernels, backends
137129
│ │ └── gui/ # Interactive visualization
138130
│ │
139-
│ ├── ringkernel-wavesim3d/ # Showcase: 3D wave simulation
140-
│ │ └── src/
141-
│ │ ├── lib.rs
142-
│ │ ├── simulation/ # 3D FDTD, actor backend, physics
143-
│ │ ├── audio/ # Binaural audio, sources, virtual head
144-
│ │ ├── visualization/ # Volume renderer, slices, camera
145-
│ │ └── gui/ # Controls panel
146-
│ │
147131
│ ├── ringkernel-txmon/ # Showcase: Transaction monitoring
148132
│ │ └── src/
149133
│ │ ├── lib.rs
@@ -169,8 +153,7 @@ RustCompute/
169153
├── examples/ # 20+ working examples
170154
│ ├── basic/
171155
│ │ ├── hello_kernel.rs # Runtime, lifecycle, suspend/resume
172-
│ │ ├── kernel_states.rs # State machine, multi-kernel
173-
│ │ └── wgpu_hello.rs # WebGPU backend
156+
│ │ └── kernel_states.rs # State machine, multi-kernel
174157
│ ├── messaging/
175158
│ │ ├── request_response.rs # Correlation IDs, priorities
176159
│ │ ├── pub_sub.rs # Topic wildcards, QoS
@@ -262,16 +245,12 @@ RustCompute/
262245
| `ringkernel-core` | Working | Core traits: RingKernel, KernelHandle, HLC, PubSub, K2K |
263246
| `ringkernel-cpu` | Working | CPU backend for development/testing |
264247
| `ringkernel-cuda` | Working | NVIDIA CUDA backend with PTX kernels |
265-
| `ringkernel-metal` | Scaffolded | Apple Metal backend (API defined) |
266-
| `ringkernel-wgpu` | Working | WebGPU cross-platform backend |
267248
| `ringkernel-derive` | Working | Proc macros for message/kernel definitions |
268249
| `ringkernel-codegen` | In Development | GPU kernel code generation |
269250
| `ringkernel-cuda-codegen` | Working | Rust-to-CUDA transpiler for GPU kernels |
270-
| `ringkernel-wgpu-codegen` | Working | Rust-to-WGSL transpiler for GPU kernels |
271251
| `ringkernel-ecosystem` | Working | Integration utilities |
272252
| `ringkernel-audio-fft` | Working | Example: GPU audio FFT processing |
273253
| `ringkernel-wavesim` | Working | Example: 2D wave simulation with FDTD |
274-
| `ringkernel-wavesim3d` | Working | Showcase: 3D wave simulation with binaural audio |
275254
| `ringkernel-txmon` | Working | Showcase: GPU-accelerated transaction monitoring |
276255
| `ringkernel-accnet` | Working | Showcase: Accounting network analytics |
277256
| `ringkernel-procint` | Working | Showcase: Process intelligence with DFG mining |
@@ -288,8 +267,6 @@ members = [
288267
"crates/ringkernel-core",
289268
"crates/ringkernel-derive",
290269
"crates/ringkernel-cuda",
291-
"crates/ringkernel-metal",
292-
"crates/ringkernel-wgpu",
293270
"crates/ringkernel-cpu",
294271
"crates/ringkernel-codegen",
295272
]
@@ -325,8 +302,6 @@ tracing-subscriber = "0.3"
325302

326303
# GPU backends
327304
cudarc = { version = "0.18.2", optional = true } # CUDA (updated API)
328-
metal = { version = "0.31", optional = true } # Metal
329-
wgpu = { version = "27.0", optional = true } # WebGPU (Arc-based)
330305

331306
# Web frameworks
332307
axum = { version = "0.8", optional = true }
@@ -390,20 +365,6 @@ Requires:
390365

391366
---
392367

393-
## Platform-Specific Compilation
394-
395-
```toml
396-
# crates/ringkernel-cuda/Cargo.toml
397-
[target.'cfg(any(target_os = "linux", target_os = "windows"))'.dependencies]
398-
cudarc = { workspace = true }
399-
400-
# crates/ringkernel-metal/Cargo.toml
401-
[target.'cfg(any(target_os = "macos", target_os = "ios"))'.dependencies]
402-
metal = { workspace = true }
403-
```
404-
405-
---
406-
407368
## Build Scripts
408369

409370
### CUDA Backend (build.rs)

docs/03-core-abstractions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ use async_trait::async_trait;
159159
/// Runtime for managing ring kernel lifecycles.
160160
#[async_trait]
161161
pub trait RingKernelRuntime: Send + Sync {
162-
/// Backend identifier (e.g., "cuda", "metal", "wgpu").
162+
/// Backend identifier (e.g., "cuda", "cpu").
163163
fn backend_name(&self) -> &'static str;
164164

165165
/// Launch a kernel (initially inactive).

docs/04-memory-management.md

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -400,37 +400,6 @@ println!("Hit rate: {:.1}%", stats.hit_rate() * 100.0);
400400

401401
---
402402

403-
## WebGPU Staging Buffer Pool (v0.3.0)
404-
405-
Efficient staging buffer reuse for GPU-to-host transfers:
406-
407-
```rust
408-
use ringkernel_wgpu::memory::{StagingBufferPool, StagingPoolStats};
409-
410-
// Create staging pool
411-
let pool = StagingBufferPool::new(&device, 16); // Max 16 buffers
412-
413-
// Acquire staging buffer for readback
414-
let staging = pool.acquire(data_size)?;
415-
416-
// Use for GPU → host copy
417-
encoder.copy_buffer_to_buffer(&gpu_buffer, 0, staging.buffer(), 0, data_size);
418-
419-
// Map and read
420-
staging.map_async(wgpu::MapMode::Read);
421-
device.poll(wgpu::Maintain::Wait);
422-
let data = staging.get_mapped_range();
423-
424-
// Buffer returned to pool on drop
425-
drop(staging);
426-
427-
// Check statistics
428-
let stats = pool.stats();
429-
println!("Staging buffer reuse rate: {:.1}%", stats.hit_rate() * 100.0);
430-
```
431-
432-
---
433-
434403
## GPU Stratified Memory Pool (v0.4.0)
435404

436405
For GPU-side buffer reuse with O(1) allocation from free lists:
@@ -563,11 +532,6 @@ impl MemoryVisibility {
563532
{
564533
Self::SystemScope // Native Windows CUDA works
565534
}
566-
567-
#[cfg(target_os = "macos")]
568-
{
569-
Self::DeviceScope // Metal doesn't have system atomics
570-
}
571535
}
572536
}
573537

0 commit comments

Comments
 (0)