@dheuv/xgboost-wasm 1.0.0

package/dist/xgboost.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Represents a trained XGBoost booster model.
+ */
+export interface Booster {
+    /** Loads a model from a path in the virtual file system. */
+    loadModel(path: string): void;
+    /** Saves a model to a path in the virtual file system. */
+    saveModel(path: string): void;
+    /** Sets a booster parameter. */
+    setParam(name: string, value: string): void;
+    /** Updates the booster for one iteration using the given training data. */
+    updateOneIter(iter: number, dtrain: DMatrix): void;
+    /**
+     * Makes predictions on the given DMatrix.
+     * @returns A JSON string containing the predictions.
+     */
+    predict(dmat: DMatrix, option?: number, ntreeLimit?: number): string;
+}
+/**
+ * Represents a data matrix used by XGBoost.
+ */
+export interface DMatrix {
+    /** Sets additional float information (like labels) for the DMatrix. */
+    setFloatInfo(field: string, dataPtr: number, len: number): void;
+    /** Returns the number of rows in the DMatrix. */
+    getNumRow(): number;
+    /** Returns the number of columns in the DMatrix. */
+    getNumCol(): number;
+}
+/**
+ * Interface for the internal Emscripten module.
+ */
+export interface XGBoostModule {
+    Booster: new () => Booster;
+    DMatrix: new (dataPtr: number, nrow: number, ncol: number, missing: number) => DMatrix;
+    XGBoostVersion(): string;
+    XGBGetLastError(): string;
+    UTF8ToString(ptr: number): string;
+    _malloc(size: number): number;
+    _free(ptr: number): void;
+    HEAPF32: Float32Array;
+}
+/**
+ * Initializes the XGBoost WASM module.
+ */
+export declare function init(): Promise<XGBoostModule>;
+/**
+ * Main class for interacting with XGBoost WASM.
+ */
+export declare class XGBoost {
+    private module;
+    constructor(module: XGBoostModule);
+    /**
+     * Creates a new XGBoost instance by initializing the WASM module.
+     */
+    static create(): Promise<XGBoost>;
+    /**
+     * Returns the version of the underlying XGBoost library.
+     */
+    version(): string;
+    /**
+     * Creates an empty booster model.
+     */
+    createBooster(): Booster;
+    /**
+     * Creates a DMatrix from feature data and optional labels.
+     * @param data Feature data as a Float32Array.
+     * @param nrow Number of rows.
+     * @param ncol Number of columns.
+     * @param missing Value to treat as missing.
+     * @param label Optional training labels.
+     */
+    createDMatrix(data: Float32Array, nrow: number, ncol: number, missing?: number, label?: Float32Array): DMatrix;
+    /**
+     * Trains a model for a specified number of rounds.
+     * @param dtrain Training data.
+     * @param params Training parameters (e.g., objective, max_depth).
+     * @param rounds Number of boosting rounds.
+     */
+    train(dtrain: DMatrix, params: Record<string, string>, rounds: number): Promise<Booster>;
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@dheuv/xgboost-wasm",
+  "version": "1.0.0",
+  "description": "XGBoost WebAssembly library for Node.js and Browser",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build:cpp": "./scripts/build_wasm.sh",
+    "build:js": "rollup -c",
+    "build": "npm run build:cpp && npm run build:js",
+    "test": "vitest"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.0",
+    "@rollup/plugin-node-resolve": "^15.0.0",
+    "@rollup/plugin-terser": "^0.4.0",
+    "@rollup/plugin-typescript": "^11.0.0",
+    "rollup": "^4.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^0.34.0"
+  },
+  "type": "module",
+  "dependencies": {
+    "tslib": "^2.8.1"
+  }
+}