fastlowess-wasm 3.0.0 → 3.1.0

package/README.md

@@ -2,21 +2,8 @@
 # LOWESS Project
 
 <p align="center">
-  <a href="https://crates.io/crates/lowess"><img src="https://img.shields.io/badge/lowess-000000?logo=rust&logoColor=white" alt="lowess"></a>
-  <a href="https://crates.io/crates/fastLowess"><img src="https://img.shields.io/badge/fastLowess-000000?logo=rust&logoColor=white" alt="fastLowess"></a>
-  <a href="https://pypi.org/project/fastlowess/"><img src="https://img.shields.io/badge/PyPI-3775A9?logo=pypi&logoColor=white" alt="PyPI"></a>
-  <a href="https://thisisamirv.r-universe.dev/rfastlowess"><img src="https://img.shields.io/badge/R--universe-276DC3?logo=r&logoColor=white" alt="R-universe"></a>
-  <a href="https://www.npmjs.com/package/fastlowess"><img src="https://img.shields.io/badge/npm-CB3837?logo=npm&logoColor=white" alt="npm"></a>
-  <a href="https://juliahub.com/ui/Packages/General/FastLOWESS"><img src="https://img.shields.io/badge/Julia-9558B2?logo=julia&logoColor=white" alt="Julia"></a>
   <a href="https://www.npmjs.com/package/fastlowess-wasm"><img src="https://img.shields.io/badge/WASM-654FF0?logo=webassembly&logoColor=white" alt="WASM"></a>
-  <a href="https://github.com/thisisamirv/lowess-project/releases/latest"><img src="https://img.shields.io/badge/C++-00599C?logo=cplusplus&logoColor=white" alt="C++"></a>
-  <br>
-  <a href="https://anaconda.org/conda-forge/fastlowess"><img src="https://img.shields.io/badge/fastlowess_(Python)-44A833?logo=anaconda&logoColor=white" alt="fastlowess (Python)"></a>
-  <a href="https://anaconda.org/conda-forge/libfastlowess"><img src="https://img.shields.io/badge/libfastlowess_(C++)-44A833?logo=anaconda&logoColor=white" alt="libfastlowess (C++)"></a>
-  <a href="https://anaconda.org/conda-forge/r-rfastlowess"><img src="https://img.shields.io/badge/rfastlowess_(R)-44A833?logo=anaconda&logoColor=white" alt="rfastlowess (R)"></a>
-  <br>
-  <a href="https://github.com/thisisamirv/lowess-project/actions/workflows/ci.yml"><img src="https://github.com/thisisamirv/lowess-project/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
-  <a href="https://github.com/ropensci/software-review/issues/769"><img src="https://badges.ropensci.org/769_status.svg" alt="Status at rOpenSci Software Peer Review"></a>
+  <a href="https://github.com/thisisamirv/lowess-project/actions/workflows/ci-wasm.yml"><img src="https://github.com/thisisamirv/lowess-project/actions/workflows/ci-wasm.yml/badge.svg" alt="CI"></a>
 </p>
 
 <p align="center">
@@ -27,18 +14,7 @@
 
 The fastest, most robust, and most feature-complete language-agnostic LOWESS (Locally Weighted Scatterplot Smoothing) implementation for **Rust**, **Python**, **R**, **Julia**, **JavaScript**, **C++**, and **WebAssembly**.
 
-> [!IMPORTANT]
->
-> The `lowess-project` contains a complete ecosystem for LOWESS smoothing:
->
-> - **[`lowess`](https://crates.io/crates/lowess)** - Core single-threaded Rust implementation with `no_std` support
-> - **[`fastLowess`](https://crates.io/crates/fastLowess)** - Parallel CPU and GPU-accelerated Rust wrapper with ndarray integration  
-> - **[`R bindings`](https://thisisamirv.r-universe.dev/rfastlowess)** - extendr-based R binding
-> - **[`Python bindings`](https://pypi.org/project/fastlowess/)** - PyO3-based Python binding
-> - **[`Julia bindings`](https://juliahub.com/ui/Packages/General/FastLOWESS)** - Native Julia binding with C FFI
-> - **[`JavaScript bindings`](https://www.npmjs.com/package/fastlowess)** - Node.js binding
-> - **[`WebAssembly bindings`](https://www.npmjs.com/package/fastlowess-wasm)** - WASM binding
-> - **[`C++ bindings`](https://github.com/thisisamirv/lowess-project/releases/latest)** - Native C++ binding with CMake integration
+The `lowess-project` also offers bindings for Rust, Python, R, Julia, Node.js, WebAssembly, and C++ — see the [full repository](https://github.com/thisisamirv/lowess-project).
 
 ---
 
@@ -46,17 +22,13 @@ The fastest, most robust, and most feature-complete language-agnostic LOWESS (Lo
 
 > [!NOTE]
 >
-> Currently available for R, Python, Rust, Julia, Node.js, WebAssembly, and C++. See the [Installation Guide](https://lowess.readthedocs.io/getting-started/installation/) for detailed installation instructions.
-
-### GPU Backend
-
-In addition to `parallel = true` (multi-core CPU), the batch `Lowess` class in every binding — except WebAssembly — as well as the `fastLowess` Rust crate itself, can run on the GPU via `wgpu` (Vulkan/Metal/DX12). It's opt-in and worth enabling for high-throughput processing of large datasets (roughly 10k+ points); for smaller inputs the CPU backend is typically faster. `StreamingLowess`/`OnlineLowess` remain CPU-only. See the [GPU Backend guide](https://lowess.readthedocs.io/en/latest/user-guide/gpu-backend/) for installation instructions and usage.
+> Currently available for R, Python, Rust, Julia, Node.js, WebAssembly, and C++. See the [Installation Guide](https://thisisamirv.github.io/lowess-project/wasm/installation/) for detailed installation instructions.
 
 ## Documentation
 
 > [!NOTE]
 >
-> ### 📚 [View the full documentation](https://lowess.readthedocs.io/)
+> ### 📚 [View the full documentation](https://thisisamirv.github.io/lowess-project/wasm/)
 
 ---
 
@@ -80,7 +52,7 @@ In addition to `parallel = true` (multi-core CPU), the batch `Lowess` class in e
 
 The `lowess` project beats the competition in terms of speed, whether in single-threaded or multi-threaded parallel execution. It is on average **200-327x faster** than Python's `statsmodels.lowess` and **2-3x faster** than R's `lowess`.
 
-For more details on the performance comparison, see the [Benchmarks](https://lowess.readthedocs.io/benchmarks/) page.
+For more details on the performance comparison, see the [Benchmarks](https://thisisamirv.github.io/lowess-project/wasm/benchmarks/) page.
 
 ### Robustness
 
@@ -151,240 +123,6 @@ All implementations are **numerical twins** of R's `lowess`:
 
 ## API Reference
 
-**R:**
-
-```r
-library(rfastlowess)
-
-model <- Lowess(
-    fraction = 0.5,
-    iterations = 3L,
-    delta = 0.01,
-    weight_function = "tricube",
-    robustness_method = "bisquare",
-    scaling_method = "mad",
-    zero_weight_fallback = "use_local_mean",
-    boundary_policy = "extend",
-    confidence_intervals = 0.95,
-    prediction_intervals = 0.95,
-    return_diagnostics = TRUE,
-    return_residuals = TRUE,
-    return_robustness_weights = TRUE,
-    return_se = TRUE,
-    cv_fractions = c(0.3, 0.5, 0.7),
-    cv_method = "kfold",
-    cv_k = 5L,
-    cv_seed = 123L,
-    auto_converge = 1e-4,
-    parallel = TRUE
-)
-custom_weights <- rep(1, length(x))
-result <- fit(model, x, y, custom_weights = custom_weights)
-
-# Result structure:
-result$x,
-result$y,
-result$standard_errors,
-result$confidence_lower,
-result$confidence_upper,
-result$prediction_lower,
-result$prediction_upper,
-result$residuals,
-result$robustness_weights,
-result$diagnostics,
-result$iterations_used,
-result$fraction_used,
-result$cv_scores
-```
-
-**Python:**
-
-```python
-from fastlowess import Lowess
-
-model = Lowess(
-    fraction=0.5,
-    iterations=3,
-    delta=0.01,
-    weight_function="tricube",
-    robustness_method="bisquare",
-    scaling_method="mad",
-    zero_weight_fallback="use_local_mean",
-    boundary_policy="extend",
-    confidence_intervals=0.95,
-    prediction_intervals=0.95,
-    return_diagnostics=True,
-    return_residuals=True,
-    return_robustness_weights=True,
-    return_se=True,
-    cv_fractions=[0.3, 0.5, 0.7],
-    cv_method="kfold",
-    cv_k=5,
-    cv_seed=123,
-    auto_converge=1e-4,
-    parallel=True
-)
-custom_weights = [1.0] * len(x)
-result = model.fit(x, y, custom_weights=custom_weights)
-
-# Result structure:
-result.x,
-result.y,
-result.standard_errors,
-result.confidence_lower,
-result.confidence_upper,
-result.prediction_lower,
-result.prediction_upper,
-result.residuals,
-result.robustness_weights,
-result.diagnostics,
-result.iterations_used,
-result.fraction_used,
-result.cv_scores
-```
-
-**Rust:**
-
-```rust
-use lowess::prelude::*;
-
-let model = Lowess::new()
-    .fraction(0.5)
-    .iterations(3)
-    .delta(0.01)
-    .weight_function("tricube")
-    .robustness_method("bisquare")
-    .scaling_method("mad")
-    .zero_weight_fallback("use_local_mean")
-    .boundary_policy("extend")
-    .return_se()
-    .confidence_intervals(0.95)
-    .prediction_intervals(0.95)
-    .return_diagnostics()
-    .return_residuals()
-    .return_robustness_weights()
-    .cv_method("kfold")
-    .cv_k(5)
-    .cv_fractions(vec![0.3, 0.5, 0.7])
-    .cv_seed(123)
-    .auto_converge(1e-4)
-    .custom_weights(vec![1.0; x.len()])
-    .build()?;
-
-let result = model.fit(&x, &y)?;
-
-// Result structure:
-pub struct LowessResult<T> {
-    pub x: Vec<T>,                           // Sorted x values
-    pub y: Vec<T>,                           // Smoothed y values
-    pub standard_errors: Option<Vec<T>>,
-    pub confidence_lower: Option<Vec<T>>,
-    pub confidence_upper: Option<Vec<T>>,
-    pub prediction_lower: Option<Vec<T>>,
-    pub prediction_upper: Option<Vec<T>>,
-    pub residuals: Option<Vec<T>>,
-    pub robustness_weights: Option<Vec<T>>,
-    pub diagnostics: Option<Diagnostics<T>>,
-    pub iterations_used: Option<usize>,
-    pub fraction_used: T,
-    pub cv_scores: Option<Vec<T>>,
-}
-```
-
-**Julia:**
-
-```julia
-using FastLOWESS
-
-model = Lowess(;
-    fraction=0.5,
-    iterations=3,
-    delta=NaN,  # NaN for auto
-    weight_function="tricube",
-    robustness_method="bisquare",
-    scaling_method="mad",
-    zero_weight_fallback="use_local_mean",
-    boundary_policy="extend",
-    confidence_intervals=NaN,
-    prediction_intervals=NaN,
-    return_diagnostics=true,
-    return_residuals=true,
-    return_robustness_weights=true,
-    return_se=true,
-    cv_fractions=Float64[], # e.g. [0.3, 0.5]
-    cv_method="kfold",
-    cv_k=5,
-    cv_seed=123,
-    auto_converge=NaN,
-    parallel=true
-)
-custom_weights = ones(length(x))
-result = fit(model, x, y; custom_weights=custom_weights)
-
-# Result structure:
-result.x,
-result.y,
-result.standard_errors,
-result.confidence_lower,
-result.confidence_upper,
-result.prediction_lower,
-result.prediction_upper,
-result.residuals,
-result.robustness_weights,
-result.diagnostics,
-result.iterations_used,
-result.fraction_used,
-result.cv_scores
-```
-
-**Node.js:**
-
-```javascript
-import { Lowess } from "fastlowess"
-
-const model = new Lowess({
-    fraction: 0.5,
-    iterations: 3,
-    delta: 0.01,
-    weight_function: "tricube",
-    robustness_method: "bisquare",
-    scaling_method: "mad",
-    zero_weight_fallback: "use_local_mean",
-    boundary_policy: "extend",
-    return_se: true,
-    confidence_intervals: 0.95,
-    prediction_intervals: 0.95,
-    return_diagnostics: true,
-    return_residuals: true,
-    return_robustness_weights: true,
-    cv_fractions: [0.3, 0.5, 0.7],
-    cv_method: "kfold",
-    cv_k: 5,
-    cv_seed: 123,
-    auto_converge: 1e-4,
-    parallel: true
-})
-const custom_weights = Array(x.length).fill(1.0)
-const result = model.fit(x, y, custom_weights)
-
-// Result structure:
-result.x,
-result.y,
-result.standard_errors,
-result.confidence_lower,
-result.confidence_upper,
-result.prediction_lower,
-result.prediction_upper,
-result.residuals,
-result.robustness_weights,
-result.diagnostics,
-result.iterations_used,
-result.fraction_used,
-result.cv_scores
-```
-
-**WebAssembly:**
-
 ```javascript
 import { Lowess } from "fastlowess-wasm"
 
@@ -429,62 +167,15 @@ result.fraction_used,
 result.cv_scores
 ```
 
-**C++:**
-
-```cpp
-#include "fastlowess.hpp"
-
-fastlowess::LowessOptions options;
-options.fraction = 0.5;
-options.iterations = 3;
-options.delta = 0.01;
-options.weight_function = "tricube";
-options.robustness_method = "bisquare";
-options.scaling_method = "mad";
-options.zero_weight_fallback = "use_local_mean";
-options.boundary_policy = "extend";
-options.confidence_intervals = 0.95;
-options.prediction_intervals = 0.95;
-options.return_diagnostics = true;
-options.return_residuals = true;
-options.return_robustness_weights = true;
-options.return_se = true;
-options.cv_fractions = {0.3, 0.5, 0.7};
-options.cv_method = "kfold";
-options.cv_k = 5;
-options.cv_seed = 123;
-options.auto_converge = 1e-4;
-options.parallel = true;
-
-fastlowess::Lowess model(options);
-std::vector<double> custom_weights(x.size(), 1.0);
-const auto result = model.fit(x, y, custom_weights).value();
-
-// Result structure:
-result.x_vector(),
-result.y_vector(),
-result.standard_errors(),
-result.confidence_lower(),
-result.confidence_upper(),
-result.prediction_lower(),
-result.prediction_upper(),
-result.residuals(),
-result.robustness_weights(),
-result.diagnostics(),
-result.iterations_used(),
-result.fraction_used(),
-result.cv_scores()
-```
-
 ---
 
 ## Contributing
 
-Contributions are welcome! Please see the [Contributing Guide](https://lowess.readthedocs.io/en/latest/contributing/) for more information.
+Contributions are welcome! Please see [CONTRIBUTING.md](https://github.com/thisisamirv/lowess-project/blob/main/CONTRIBUTING.md) for more information.
 
 ## Changelog
 
-See the [Changelog](https://lwoess.readthedocs.io/en/latest/changelog/) for a history of changes.
+See [CHANGELOG.md](https://github.com/thisisamirv/lowess-project/blob/main/CHANGELOG.md) for a history of changes.
 
 ## License
 

package/package.json

@@ -5,7 +5,7 @@
     "Amir Valizadeh <thisisamirv@gmail.com>"
   ],
   "description": "High-performance LOWESS (Locally Weighted Scatterplot Smoothing)",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "license": "MIT OR Apache-2.0",
   "repository": {
     "type": "git",
@@ -29,4 +29,4 @@
     "regression",
     "bioinformatics"
   ]
-}
+}