bun-scikit 0.1.1 → 0.1.3

package/README.md

@@ -62,8 +62,8 @@ bun install bun-scikit
 
 Postinstall behavior:
 
-- Downloads prebuilt native binaries from GitHub Releases for `linux-x64` and `windows-x64`.
-- If prebuilt binaries are unavailable, it falls back to local native build.
+- Prebuilt native binaries for `linux-x64` and `windows-x64` are bundled in the npm package.
+- No `bun pm trust` step is required for normal install/use.
 - macOS prebuilt binaries are currently not published.
 
 ## Usage

package/docs/README.md

@@ -5,3 +5,4 @@
 - Generated API docs (Typedoc output): `docs/api-reference/`
 - Benchmarking and CI snapshot flow: `docs/benchmarking.md`
 - Zig native acceleration: `docs/zig-acceleration.md`
+- Release checklist: `docs/release-checklist.md`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bun-scikit",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "A scikit-learn-inspired machine learning library for Bun/TypeScript.",
   "license": "MIT",
   "module": "index.ts",
@@ -30,10 +30,10 @@
   },
   "files": [
     "index.ts",
+    "prebuilt",
     "src",
     "zig",
     "scripts",
-    "binding.gyp",
     "docs/native-abi.md",
     "README.md",
     "LICENSE"
@@ -43,7 +43,6 @@
     "bun": ">=1.3.9"
   },
   "scripts": {
-    "install": "bun run scripts/install-native.ts",
     "test": "bun test",
     "typecheck": "bunx tsc --noEmit",
     "bench": "bun run bench/heart.bench.ts",

package/scripts/check-benchmark-health.ts

@@ -31,6 +31,8 @@ interface BenchmarkSnapshot {
     regression: {
       results: [RegressionBenchmarkResult, RegressionBenchmarkResult];
       comparison: {
+        fitSpeedupVsSklearn: number;
+        predictSpeedupVsSklearn: number;
         mseDeltaVsSklearn: number;
         r2DeltaVsSklearn: number;
       };
@@ -38,16 +40,46 @@ interface BenchmarkSnapshot {
     classification: {
       results: [ClassificationBenchmarkResult, ClassificationBenchmarkResult];
       comparison: {
+        fitSpeedupVsSklearn: number;
+        predictSpeedupVsSklearn: number;
         accuracyDeltaVsSklearn: number;
         f1DeltaVsSklearn: number;
       };
     };
     treeClassification: {
-      models: [TreeModelComparison, TreeModelComparison];
+      models: [
+        TreeModelComparison & {
+          comparison: TreeModelComparison["comparison"] & {
+            fitSpeedupVsSklearn: number;
+            predictSpeedupVsSklearn: number;
+          };
+        },
+        TreeModelComparison & {
+          comparison: TreeModelComparison["comparison"] & {
+            fitSpeedupVsSklearn: number;
+            predictSpeedupVsSklearn: number;
+          };
+        },
+      ];
     };
   };
 }
 
+function speedupThreshold(
+  envName: string,
+  defaultValue: number,
+): number {
+  const raw = process.env[envName];
+  if (!raw) {
+    return defaultValue;
+  }
+  const parsed = Number(raw);
+  if (!Number.isFinite(parsed) || parsed <= 0) {
+    throw new Error(`${envName} must be a positive number when set. Got: ${raw}`);
+  }
+  return parsed;
+}
+
 const pathArgIndex = Bun.argv.indexOf("--input");
 const inputPath =
   pathArgIndex !== -1 && pathArgIndex + 1 < Bun.argv.length
@@ -59,6 +91,23 @@ const snapshot = JSON.parse(await readFile(inputPath, "utf-8")) as BenchmarkSnap
 const [bunRegression, sklearnRegression] = snapshot.suites.regression.results;
 const [bunClassification, sklearnClassification] = snapshot.suites.classification.results;
 const [decisionTree, randomForest] = snapshot.suites.treeClassification.models;
+const minRegressionFitSpeedup = speedupThreshold("BENCH_MIN_REGRESSION_FIT_SPEEDUP", 1.1);
+const minRegressionPredictSpeedup = speedupThreshold("BENCH_MIN_REGRESSION_PREDICT_SPEEDUP", 1.1);
+const minClassificationFitSpeedup = speedupThreshold("BENCH_MIN_CLASSIFICATION_FIT_SPEEDUP", 1.3);
+const minClassificationPredictSpeedup = speedupThreshold(
+  "BENCH_MIN_CLASSIFICATION_PREDICT_SPEEDUP",
+  1.3,
+);
+const minDecisionTreeFitSpeedup = speedupThreshold("BENCH_MIN_DECISION_TREE_FIT_SPEEDUP", 1.2);
+const minDecisionTreePredictSpeedup = speedupThreshold(
+  "BENCH_MIN_DECISION_TREE_PREDICT_SPEEDUP",
+  1.5,
+);
+const minRandomForestFitSpeedup = speedupThreshold("BENCH_MIN_RANDOM_FOREST_FIT_SPEEDUP", 2.0);
+const minRandomForestPredictSpeedup = speedupThreshold(
+  "BENCH_MIN_RANDOM_FOREST_PREDICT_SPEEDUP",
+  2.0,
+);
 
 for (const result of [
   bunRegression,
@@ -99,6 +148,18 @@ if (Math.abs(snapshot.suites.regression.comparison.mseDeltaVsSklearn) > 0.01) {
   );
 }
 
+if (snapshot.suites.regression.comparison.fitSpeedupVsSklearn < minRegressionFitSpeedup) {
+  throw new Error(
+    `Regression fit speedup too low: ${snapshot.suites.regression.comparison.fitSpeedupVsSklearn} < ${minRegressionFitSpeedup}.`,
+  );
+}
+
+if (snapshot.suites.regression.comparison.predictSpeedupVsSklearn < minRegressionPredictSpeedup) {
+  throw new Error(
+    `Regression predict speedup too low: ${snapshot.suites.regression.comparison.predictSpeedupVsSklearn} < ${minRegressionPredictSpeedup}.`,
+  );
+}
+
 if (Math.abs(snapshot.suites.regression.comparison.r2DeltaVsSklearn) > 0.01) {
   throw new Error(
     `Regression R2 delta too large: ${snapshot.suites.regression.comparison.r2DeltaVsSklearn}.`,
@@ -117,6 +178,21 @@ if (Math.abs(snapshot.suites.classification.comparison.f1DeltaVsSklearn) > 0.05)
   );
 }
 
+if (snapshot.suites.classification.comparison.fitSpeedupVsSklearn < minClassificationFitSpeedup) {
+  throw new Error(
+    `Classification fit speedup too low: ${snapshot.suites.classification.comparison.fitSpeedupVsSklearn} < ${minClassificationFitSpeedup}.`,
+  );
+}
+
+if (
+  snapshot.suites.classification.comparison.predictSpeedupVsSklearn <
+  minClassificationPredictSpeedup
+) {
+  throw new Error(
+    `Classification predict speedup too low: ${snapshot.suites.classification.comparison.predictSpeedupVsSklearn} < ${minClassificationPredictSpeedup}.`,
+  );
+}
+
 if (Math.abs(decisionTree.comparison.accuracyDeltaVsSklearn) > 0.08) {
   throw new Error(
     `DecisionTree accuracy delta too large: ${decisionTree.comparison.accuracyDeltaVsSklearn}.`,
@@ -127,6 +203,18 @@ if (Math.abs(decisionTree.comparison.f1DeltaVsSklearn) > 0.08) {
   throw new Error(`DecisionTree F1 delta too large: ${decisionTree.comparison.f1DeltaVsSklearn}.`);
 }
 
+if (decisionTree.comparison.fitSpeedupVsSklearn < minDecisionTreeFitSpeedup) {
+  throw new Error(
+    `DecisionTree fit speedup too low: ${decisionTree.comparison.fitSpeedupVsSklearn} < ${minDecisionTreeFitSpeedup}.`,
+  );
+}
+
+if (decisionTree.comparison.predictSpeedupVsSklearn < minDecisionTreePredictSpeedup) {
+  throw new Error(
+    `DecisionTree predict speedup too low: ${decisionTree.comparison.predictSpeedupVsSklearn} < ${minDecisionTreePredictSpeedup}.`,
+  );
+}
+
 if (Math.abs(randomForest.comparison.accuracyDeltaVsSklearn) > 0.08) {
   throw new Error(
     `RandomForest accuracy delta too large: ${randomForest.comparison.accuracyDeltaVsSklearn}.`,
@@ -137,4 +225,16 @@ if (Math.abs(randomForest.comparison.f1DeltaVsSklearn) > 0.08) {
   throw new Error(`RandomForest F1 delta too large: ${randomForest.comparison.f1DeltaVsSklearn}.`);
 }
 
+if (randomForest.comparison.fitSpeedupVsSklearn < minRandomForestFitSpeedup) {
+  throw new Error(
+    `RandomForest fit speedup too low: ${randomForest.comparison.fitSpeedupVsSklearn} < ${minRandomForestFitSpeedup}.`,
+  );
+}
+
+if (randomForest.comparison.predictSpeedupVsSklearn < minRandomForestPredictSpeedup) {
+  throw new Error(
+    `RandomForest predict speedup too low: ${randomForest.comparison.predictSpeedupVsSklearn} < ${minRandomForestPredictSpeedup}.`,
+  );
+}
+
 console.log("Benchmark comparison health checks passed.");

package/src/native/zigKernels.ts

@@ -191,9 +191,16 @@ function candidateLibraryPaths(): string[] {
   const extension = suffix;
   const fileName = `bun_scikit_kernels.${extension}`;
   const explicitPath = process.env.BUN_SCIKIT_ZIG_LIB;
+  const platformPackagedPath =
+    process.platform === "win32"
+      ? resolve(import.meta.dir, "../../prebuilt/windows-x64", fileName)
+      : process.platform === "linux"
+        ? resolve(import.meta.dir, "../../prebuilt/linux-x64", fileName)
+        : null;
 
   const candidates = [
     explicitPath,
+    platformPackagedPath,
     resolve(process.cwd(), "dist", "native", fileName),
     resolve(process.cwd(), "native", fileName),
     resolve(import.meta.dir, "../../dist/native", fileName),
@@ -204,8 +211,15 @@ function candidateLibraryPaths(): string[] {
 }
 
 function candidateAddonPaths(): string[] {
+  const platformPackagedPath =
+    process.platform === "win32"
+      ? resolve(import.meta.dir, "../../prebuilt/windows-x64", "bun_scikit_node_addon.node")
+      : process.platform === "linux"
+        ? resolve(import.meta.dir, "../../prebuilt/linux-x64", "bun_scikit_node_addon.node")
+        : null;
   const candidates = [
     process.env.BUN_SCIKIT_NODE_ADDON,
+    platformPackagedPath,
     resolve(process.cwd(), "dist", "native", "bun_scikit_node_addon.node"),
     resolve(process.cwd(), "build", "Release", "bun_scikit_node_addon.node"),
     resolve(import.meta.dir, "../../dist/native", "bun_scikit_node_addon.node"),

package/binding.gyp

@@ -1,21 +0,0 @@
-{
-  "targets": [
-    {
-      "target_name": "bun_scikit_node_addon",
-      "sources": [ "src/native/node-addon/bun_scikit_addon.cpp" ],
-      "include_dirs": [
-        "<!@(node -p \"require('node-addon-api').include\")"
-      ],
-      "dependencies": [
-        "<!(node -p \"require('node-addon-api').gyp\")"
-      ],
-      "defines": [ "NAPI_DISABLE_CPP_EXCEPTIONS" ],
-      "cflags_cc!": [ "-fno-exceptions" ],
-      "msvs_settings": {
-        "VCCLCompilerTool": {
-          "ExceptionHandling": 0
-        }
-      }
-    }
-  ]
-}