From b6b91e6ed04ba29de0ec8f224e7500352ba03031 Mon Sep 17 00:00:00 2001 From: Guilherme Pedroza Date: Tue, 22 Sep 2026 21:48:22 -0300 Subject: [PATCH] docs(readme): reflect published alpha and CUDA scope Signed-off-by: Guilherme Pedroza --- README.md | 20 ++++++++++---------- crates/vrp-gpu/README.md | 21 ++++++++++----------- 2 files changed, 20 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index f8d82fc..2ee66dc 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,14 @@ VRP-GPU is an experimental Rust library for capacitated vehicle routing (CVRP). It parses Solomon-style instances, builds routes with a greedy nearest-neighbor -heuristic, and provides CPU 2-opt local search. An optional CUDA path evaluates -2-opt candidates and selects one improving move. The CPU implementation is the -correctness reference for GPU validation. +heuristic, and provides CPU 2-opt local search. The optional `gpu` feature uses +CUDA to evaluate 2-opt candidates and select one improving move; it is not a +complete GPU solver. The CPU implementation is the correctness reference. -> **Status:** experimental alpha. Public APIs may change before the first stable -> release. Check crates.io for published versions; a version in this repository -> is not evidence that it has been uploaded. +> **Published alpha:** [`vrp-gpu 0.1.0-alpha.1`](https://crates.io/crates/vrp-gpu/0.1.0-alpha.1). +> Public APIs may change before the first stable release. See the +> [API documentation](https://docs.rs/vrp-gpu/0.1.0-alpha.1/vrp_gpu/) for this +> published version. ## Workspace @@ -28,22 +29,21 @@ the pinned nightly compiler. ## Using the library -Once `0.1.0-alpha.1` is published, use its explicit prerelease version: +To use the published alpha, specify its prerelease version: ```toml [dependencies] vrp-gpu = "0.1.0-alpha.1" ``` -Until then, depend on a tested repository commit explicitly: +To try changes that have not been published, pin a tested repository commit: ```toml [dependencies] vrp-gpu = { git = "https://github.com/pedrozaz/vrp-gpu", rev = "" } ``` -Enable CUDA host orchestration with the opt-in `gpu` feature on either -dependency source: +Enable CUDA candidate evaluation with the opt-in `gpu` feature: ```toml [dependencies] diff --git a/crates/vrp-gpu/README.md b/crates/vrp-gpu/README.md index 0e4434f..6dadfbf 100644 --- a/crates/vrp-gpu/README.md +++ b/crates/vrp-gpu/README.md @@ -6,8 +6,10 @@ with a greedy nearest-neighbor heuristic, and improves routes on the CPU. The GPU API computes candidate deltas or selects a single move; it does not run a complete GPU search loop or mutate a route. -This is an experimental alpha. Check crates.io for available versions; a -version in the repository does not mean the package has been published. +The first published alpha is +[`0.1.0-alpha.1`](https://crates.io/crates/vrp-gpu/0.1.0-alpha.1). +The API may change before a stable release. See the +[documentation for that version](https://docs.rs/vrp-gpu/0.1.0-alpha.1/vrp_gpu/). ## Features @@ -21,20 +23,18 @@ PTX is precompiled; consumers do not need cuda-oxide or a nightly Rust compiler. ## Installation -Before publication, use the Git repository and pin a tested revision for a -reproducible application build: +To use the published alpha, specify its prerelease version: ```toml [dependencies] -vrp-gpu = { git = "https://github.com/pedrozaz/vrp-gpu", rev = "" } +vrp-gpu = "0.1.0-alpha.1" ``` -Once `0.1.0-alpha.1` is available on crates.io, opt in to that prerelease -explicitly: +For changes not yet published, pin a tested Git revision: ```toml [dependencies] -vrp-gpu = "0.1.0-alpha.1" +vrp-gpu = { git = "https://github.com/pedrozaz/vrp-gpu", rev = "" } ``` ## Example @@ -76,14 +76,13 @@ exhaustion only means this greedy construction failed. If instance data are constructed or changed through public fields, call `SolomonInstance::validate` before passing them to CPU routines. -To use the optional GPU API, enable the feature in the dependency: +To use the optional GPU API in the published alpha, enable the feature: ```toml [dependencies] -vrp-gpu = { git = "https://github.com/pedrozaz/vrp-gpu", rev = "", features = ["gpu"] } +vrp-gpu = { version = "0.1.0-alpha.1", features = ["gpu"] } ``` -Replace `` with the exact Git commit you validated. `gpu::evaluate_two_opt_deltas` returns a row-major `n × n` matrix with computed `f32` deltas for valid `i < j` and positive infinity elsewhere. Extreme finite input distances can still yield non-finite arithmetic results.