SPL ML Model Registry/Inference JavaScript API. 

SPL ML Model Registry/Inference JavaScript API

nerdai

calculusc

@iai-skunks/ml-registry-solana

var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {

    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

    return new (P || (P = Promise))(function (resolve, reject) {

        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }

        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }

        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }

        step((generator = generator.apply(thisArg, _arguments || [])).next());

Object.defineProperty(exports, "__esModule", { value: true });

exports.predictWithModel = exports.createModelRegistry = void 0;

const web3_js_1 = require("@solana/web3.js");

const states_1 = require("../src/states");

const custom_types_1 = require("./custom_types");

const instructions_1 = require("./instructions");

////////////////////////////////////////////////////////////

 * @param connection The solana connection object to the RPC node

 * @param programId The ML registry SPL program

 * @param payerKey The allocation cost payer

 * @param modelName The name of the new GLM

 * @param linkFunc The type of GLM. "normal" and "logreg" are supported.

 * @param coeffs The coefficients for the new GLM

 * @param space The space in bytes allocated to the account

 * @param usageFee The set usage fee per prediction with the model

 * @param feeAccountKey The account for to where fees should be deposited

 * @param intercept The intercept coeff for the GLM. If not specifed, default to 0

 * @param lamports The budget to be set for the name account. If not specified, it'll be the minimum for rent exemption

function createModelRegistry(connection, programId, payerKey, modelName, linkFunc, coeffs, space, usageFee, feeAccountKey, intercept, lamports) {

    return __awaiter(this, void 0, void 0, function* () {

        const hashedName = yield (0, utils_1.getHashedName)(modelName);

            : yield connection.getMinimumBalanceForRentExemption(space + OVERHEAD_SPACE);

        console.log("Requesting space for the model:", space + OVERHEAD_SPACE, "bytes");

        console.log("Rent for Creating Model:", balance / web3_js_1.LAMPORTS_PER_SOL, "SOL");

        // eslint-disable-next-line @typescript-eslint/no-unused-vars

        const [modelAccountPubkey, _] = yield web3_js_1.PublicKey.findProgramAddress([hashedName], programId);

        const instruction = (0, instructions_1.createInstruction)(programId, web3_js_1.SystemProgram.programId, payerKey, modelAccountPubkey, hashedName, coeffs, finalIntercept, linkFunc, new custom_types_1.Numberu64(balance), new custom_types_1.Numberu32(space), new custom_types_1.Numberu64(usageFee), feeAccountKey);

        return [instruction, modelAccountPubkey];

exports.createModelRegistry = createModelRegistry;

 * Creates a predict with specified model instruction

 * @param modelName The name of the model account, used as seed for PDA

 * @param scoreAccountName The name of the score account, used as seed for PDA

 * @param indVars The independent variables supplied for prediction

 * @param mlServiceKey The wallet to where all proportion of fees to service are deposited

 * @param mlServiceCharge The percentage cut the service earns per prediction fee

function predictWithModel(connection, programId, payerKey, modelName, scoreAccountName, indVars, space, mlServiceKey, mlServiceCharge, lamports) {

        console.log("Rent for Predict Model:", balance / web3_js_1.LAMPORTS_PER_SOL, "SOL");

        const modelHashedName = yield (0, utils_1.getHashedName)(modelName);

        const [modelAccountPubkey, _1] = yield web3_js_1.PublicKey.findProgramAddress([modelHashedName], programId);

        const scoreHashedName = yield (0, utils_1.getHashedName)(scoreAccountName);

        const [scoreAccountPubkey, _2] = yield web3_js_1.PublicKey.findProgramAddress([scoreHashedName], programId);

        // getting fee_wallet (ML model owner wallet)

        const modelState = yield states_1.ModelState.retrieve(connection, modelAccountPubkey);

        const instruction = (0, instructions_1.createPredictInstruction)(web3_js_1.SystemProgram.programId, programId, payerKey, modelAccountPubkey, modelHashedName, scoreAccountPubkey, scoreHashedName, indVars, new custom_types_1.Numberu64(balance), new custom_types_1.Numberu32(space), modelState.feeAccountKey, mlServiceKey, mlServiceCharge);

        return [instruction, scoreAccountPubkey];

exports.predictWithModel = predictWithModel;

  "name": "@iai-skunks/ml-registry-solana",

  "description": "SPL ML Model Registry/Inference JavaScript API",

    "lint:fix": "npx eslint src/*.ts --fix",

  "author": "Skunkworks at integrate.ai <skunkworks@integrate.ai>",

    "@typescript-eslint/eslint-plugin": "^5.18.0",

    "@typescript-eslint/parser": "^5.18.0",

    "eslint-plugin-eslint-comments": "^3.2.0",

- fix improper import of ModelState in bindings.ts

- added a service charge per fee when a model is used for prediction

- added counter field to model data state

- updated the type for coeffs, intercept to string type for storage

- change score state to store string version of prediction

- move functions only used in tests to test dir

- move dev depenencies out of package main exports

- remove ML_PROGRAM_ID as a constant and instead make as a parameter to be

- basic bindings to create models and use them for prediction

import { ModelState } from "../src/states";

import { Numberu32, Numberu64 } from "./custom_types";

import { createInstruction, createPredictInstruction } from "./instructions";

 * @param feeAccountKey The account for to where fees should be deposited 

export async function createModelRegistry(

): Promise<[TransactionInstruction, PublicKey]> {

  const hashedName = await getHashedName(modelName);

    : await connection.getMinimumBalanceForRentExemption(

  console.log("Rent for Creating Model:", balance / LAMPORTS_PER_SOL, "SOL");

  // eslint-disable-next-line @typescript-eslint/no-unused-vars

  const [modelAccountPubkey, _] = await PublicKey.findProgramAddress(

  return [instruction, modelAccountPubkey];

 * @param mlServiceKey The wallet to where all proportion of fees to service are deposited 

  console.log("Rent for Predict Model:", balance / LAMPORTS_PER_SOL, "SOL");

  const modelHashedName = await getHashedName(modelName);

  const [modelAccountPubkey, _1] = await PublicKey.findProgramAddress(

  const scoreHashedName = await getHashedName(scoreAccountName);

  const [scoreAccountPubkey, _2] = await PublicKey.findProgramAddress(

  // getting fee_wallet (ML model owner wallet)

  const modelState = await ModelState.retrieve(connection, modelAccountPubkey);

  const instruction = createPredictInstruction(

  return [instruction, scoreAccountPubkey];

		{
		"name": "@iai-skunks/ml-registry-solana",
		"version": "0.4.0",
		"version": "0.4.1",
		"description": "SPL ML Model Registry/Inference JavaScript API",
		@@ -5,0 +5,0 @@ "main": "dist/index.js",

		@@ -0,1 +1,4 @@
		## v0.4.1
		- fix improper import of ModelState in bindings.ts

		## v0.4.0
		@@ -2,0 +5,0 @@ - added fee payments per prediction

		@@ -14,5 +14,5 @@ "use strict";
		const web3_js_1 = require("@solana/web3.js");
		const states_1 = require("../src/states");
		const custom_types_1 = require("./custom_types");
		const instructions_1 = require("./instructions");
		const states_1 = require("./states");
		const utils_1 = require("./utils");
		@@ -19,0 +19,0 @@ ////////////////////////////////////////////////////////////

		@@ -9,6 +9,5 @@ import {

		import { ModelState } from "../src/states";

		import { Numberu32, Numberu64 } from "./custom_types";
		import { createInstruction, createPredictInstruction } from "./instructions";
		import { ModelState } from "./states";
		import { getHashedName } from "./utils";
		@@ -30,3 +29,3 @@
		* @param usageFee The set usage fee per prediction with the model
		* @param feeAccountKey The account for to where fees should be deposited
		* @param feeAccountKey The account for to where fees should be deposited
		* @param intercept The intercept coeff for the GLM. If not specifed, default to 0
		@@ -103,3 +102,3 @@ * @param lamports The budget to be set for the name account. If not specified, it'll be the minimum for rent exemption
		* @param space The space in bytes allocated to the account
		* @param mlServiceKey The wallet to where all proportion of fees to service are deposited
		* @param mlServiceKey The wallet to where all proportion of fees to service are deposited
		* @param mlServiceCharge The percentage cut the service earns per prediction fee
		@@ -106,0 +105,0 @@ * @param lamports The budget to be set for the name account. If not specified, it'll be the minimum for rent exemption

Improved metrics