@epfml/discojs-node 2.1.1 → 2.1.2-p20240506085559.0

package/dist/core/serialization/model.js

@@ -1,55 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.decode = exports.encode = exports.isEncoded = void 0;
-var tslib_1 = require("tslib");
-var __1 = require("..");
-var msgpack_lite_1 = (0, tslib_1.__importDefault)(require("msgpack-lite"));
-function isEncoded(raw) {
-    return Array.isArray(raw) && raw.every(function (r) { return typeof r === 'number'; });
-}
-exports.isEncoded = isEncoded;
-function encode(model) {
-    return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-        var saved;
-        var _this = this;
-        return (0, tslib_1.__generator)(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, new Promise(function (resolve) {
-                        void model.save({
-                            save: function (artifacts) { return (0, tslib_1.__awaiter)(_this, void 0, void 0, function () {
-                                return (0, tslib_1.__generator)(this, function (_a) {
-                                    resolve(artifacts);
-                                    return [2 /*return*/, {
-                                            modelArtifactsInfo: {
-                                                dateSaved: new Date(),
-                                                modelTopologyType: 'JSON'
-                                            }
-                                        }];
-                                });
-                            }); }
-                        });
-                    })];
-                case 1:
-                    saved = _a.sent();
-                    return [2 /*return*/, (0, tslib_1.__spreadArray)([], (0, tslib_1.__read)(msgpack_lite_1.default.encode(saved).values()), false)];
-            }
-        });
-    });
-}
-exports.encode = encode;
-function decode(encoded) {
-    return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-        var raw;
-        return (0, tslib_1.__generator)(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    raw = msgpack_lite_1.default.decode(encoded);
-                    return [4 /*yield*/, __1.tf.loadLayersModel({
-                            load: function () { return raw; }
-                        })];
-                case 1: return [2 /*return*/, _a.sent()];
-            }
-        });
-    });
-}
-exports.decode = decode;

package/dist/core/serialization/weights.d.ts

@@ -1,5 +0,0 @@
-import { WeightsContainer } from '..';
-export declare type Encoded = number[];
-export declare function isEncoded(raw: unknown): raw is Encoded;
-export declare function encode(weights: WeightsContainer): Promise<Encoded>;
-export declare function decode(encoded: Encoded): WeightsContainer;

package/dist/core/serialization/weights.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.decode = exports.encode = exports.isEncoded = void 0;
-var tslib_1 = require("tslib");
-var msgpack = (0, tslib_1.__importStar)(require("msgpack-lite"));
-var __1 = require("..");
-function isSerialized(raw) {
-    if (typeof raw !== 'object' || raw === null) {
-        return false;
-    }
-    if (!('shape' in raw && 'data' in raw)) {
-        return false;
-    }
-    var _a = raw, shape = _a.shape, data = _a.data;
-    if (!(Array.isArray(shape) && shape.every(function (e) { return typeof e === 'number'; })) ||
-        !(Array.isArray(data) && data.every(function (e) { return typeof e === 'number'; }))) {
-        return false;
-    }
-    // eslint-disable-next-line
-    var _ = { shape: shape, data: data };
-    return true;
-}
-function isEncoded(raw) {
-    return Array.isArray(raw) && raw.every(function (e) { return typeof e === 'number'; });
-}
-exports.isEncoded = isEncoded;
-function encode(weights) {
-    return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-        var serialized;
-        var _this = this;
-        return (0, tslib_1.__generator)(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, Promise.all(weights.weights.map(function (t) { return (0, tslib_1.__awaiter)(_this, void 0, void 0, function () {
-                        var _a;
-                        var _b;
-                        return (0, tslib_1.__generator)(this, function (_c) {
-                            switch (_c.label) {
-                                case 0:
-                                    _b = {
-                                        shape: t.shape
-                                    };
-                                    _a = [[]];
-                                    return [4 /*yield*/, t.data()];
-                                case 1: return [2 /*return*/, (_b.data = tslib_1.__spreadArray.apply(void 0, _a.concat([tslib_1.__read.apply(void 0, [_c.sent()]), false])),
-                                        _b)];
-                            }
-                        });
-                    }); }))];
-                case 1:
-                    serialized = _a.sent();
-                    return [2 /*return*/, (0, tslib_1.__spreadArray)([], (0, tslib_1.__read)(msgpack.encode(serialized).values()), false)];
-            }
-        });
-    });
-}
-exports.encode = encode;
-function decode(encoded) {
-    var raw = msgpack.decode(encoded);
-    if (!(Array.isArray(raw) && raw.every(isSerialized))) {
-        throw new Error('expected to decode an array of serialized weights');
-    }
-    return new __1.WeightsContainer(raw.map(function (w) { return __1.tf.tensor(w.data, w.shape); }));
-}
-exports.decode = decode;

package/dist/core/task/data_example.d.ts

@@ -1,5 +0,0 @@
-export declare function isDataExample(raw: unknown): raw is DataExample;
-export interface DataExample {
-    columnName: string;
-    columnData: string | number;
-}

package/dist/core/task/data_example.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDataExample = void 0;
-var immutable_1 = require("immutable");
-function isDataExample(raw) {
-    if (typeof raw !== 'object') {
-        return false;
-    }
-    if (raw === null) {
-        return false;
-    }
-    if (!(0, immutable_1.Set)(Object.keys(raw)).equals(immutable_1.Set.of('columnName', 'columnData'))) {
-        return false;
-    }
-    var _a = raw, columnName = _a.columnName, columnData = _a.columnData;
-    if (typeof columnName !== 'string' ||
-        (typeof columnData !== 'string' && typeof columnData !== 'number')) {
-        return false;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    var _ = { columnName: columnName, columnData: columnData };
-    return true;
-}
-exports.isDataExample = isDataExample;

package/dist/core/task/digest.d.ts

@@ -1,5 +0,0 @@
-export interface Digest {
-    algorithm: string;
-    value: string;
-}
-export declare function isDigest(raw: unknown): raw is Digest;

package/dist/core/task/digest.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDigest = void 0;
-function isDigest(raw) {
-    if (typeof raw !== 'object') {
-        return false;
-    }
-    if (raw === null) {
-        return false;
-    }
-    var _a = raw, algorithm = _a.algorithm, value = _a.value;
-    if (!(typeof algorithm === 'string' &&
-        typeof value === 'string')) {
-        return false;
-    }
-    return true;
-}
-exports.isDigest = isDigest;

package/dist/core/task/display_information.d.ts

@@ -1,15 +0,0 @@
-import { Summary } from './summary';
-import { DataExample } from './data_example';
-export declare function isDisplayInformation(raw: unknown): raw is DisplayInformation;
-export interface DisplayInformation {
-    taskTitle?: string;
-    summary?: Summary;
-    tradeoffs?: string;
-    dataFormatInformation?: string;
-    dataExampleText?: string;
-    model?: string;
-    dataExample?: DataExample[];
-    headers?: string[];
-    dataExampleImage?: string;
-    limitations?: string;
-}

package/dist/core/task/display_information.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDisplayInformation = void 0;
-var summary_1 = require("./summary");
-var data_example_1 = require("./data_example");
-function isDisplayInformation(raw) {
-    if (typeof raw !== 'object') {
-        return false;
-    }
-    if (raw === null) {
-        return false;
-    }
-    var _a = raw, dataExample = _a.dataExample, dataExampleImage = _a.dataExampleImage, dataExampleText = _a.dataExampleText, dataFormatInformation = _a.dataFormatInformation, headers = _a.headers, limitations = _a.limitations, model = _a.model, summary = _a.summary, taskTitle = _a.taskTitle, tradeoffs = _a.tradeoffs;
-    if (typeof taskTitle !== 'string' ||
-        (dataExampleText !== undefined && typeof dataExampleText !== 'string') ||
-        (dataFormatInformation !== undefined && typeof dataFormatInformation !== 'string') ||
-        (tradeoffs !== undefined && typeof tradeoffs !== 'string') ||
-        (model !== undefined && typeof model !== 'string') ||
-        (dataExampleImage !== undefined && typeof dataExampleImage !== 'string') ||
-        (limitations !== undefined && typeof limitations !== 'string')) {
-        return false;
-    }
-    if (summary !== undefined && !(0, summary_1.isSummary)(summary)) {
-        return false;
-    }
-    if (dataExample !== undefined && !(Array.isArray(dataExample) &&
-        dataExample.every(data_example_1.isDataExample))) {
-        return false;
-    }
-    if (headers !== undefined && !(Array.isArray(headers) &&
-        headers.every(function (e) { return typeof e === 'string'; }))) {
-        return false;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    var _ = {
-        taskTitle: taskTitle,
-        summary: summary,
-        tradeoffs: tradeoffs,
-        dataFormatInformation: dataFormatInformation,
-        dataExampleText: dataExampleText,
-        model: model,
-        dataExample: dataExample,
-        headers: headers,
-        dataExampleImage: dataExampleImage,
-        limitations: limitations
-    };
-    return true;
-}
-exports.isDisplayInformation = isDisplayInformation;

package/dist/core/task/index.d.ts

@@ -1,6 +0,0 @@
-export { isTask, Task, isTaskID, TaskID } from './task';
-export { TaskProvider, isTaskProvider } from './task_provider';
-export { isDigest, Digest } from './digest';
-export { isDisplayInformation, DisplayInformation } from './display_information';
-export { TrainingInformation } from './training_information';
-export { pushTask, fetchTasks } from './task_handler';

package/dist/core/task/index.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchTasks = exports.pushTask = exports.isDisplayInformation = exports.isDigest = exports.isTaskProvider = exports.isTaskID = exports.isTask = void 0;
-var task_1 = require("./task");
-Object.defineProperty(exports, "isTask", { enumerable: true, get: function () { return task_1.isTask; } });
-Object.defineProperty(exports, "isTaskID", { enumerable: true, get: function () { return task_1.isTaskID; } });
-var task_provider_1 = require("./task_provider");
-Object.defineProperty(exports, "isTaskProvider", { enumerable: true, get: function () { return task_provider_1.isTaskProvider; } });
-var digest_1 = require("./digest");
-Object.defineProperty(exports, "isDigest", { enumerable: true, get: function () { return digest_1.isDigest; } });
-var display_information_1 = require("./display_information");
-Object.defineProperty(exports, "isDisplayInformation", { enumerable: true, get: function () { return display_information_1.isDisplayInformation; } });
-var task_handler_1 = require("./task_handler");
-Object.defineProperty(exports, "pushTask", { enumerable: true, get: function () { return task_handler_1.pushTask; } });
-Object.defineProperty(exports, "fetchTasks", { enumerable: true, get: function () { return task_handler_1.fetchTasks; } });

package/dist/core/task/model_compile_data.d.ts

@@ -1,6 +0,0 @@
-export declare function isModelCompileData(raw: unknown): raw is ModelCompileData;
-export interface ModelCompileData {
-    optimizer: string;
-    loss: string;
-    metrics: string[];
-}

package/dist/core/task/model_compile_data.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isModelCompileData = void 0;
-function isModelCompileData(raw) {
-    if (typeof raw !== 'object') {
-        return false;
-    }
-    if (raw === null) {
-        return false;
-    }
-    var _a = raw, optimizer = _a.optimizer, loss = _a.loss, metrics = _a.metrics;
-    if (typeof optimizer !== 'string' ||
-        typeof loss !== 'string') {
-        return false;
-    }
-    if (!(Array.isArray(metrics) &&
-        metrics.every(function (e) { return typeof e === 'string'; }))) {
-        return false;
-    }
-    return true;
-}
-exports.isModelCompileData = isModelCompileData;

package/dist/core/task/summary.d.ts

@@ -1,5 +0,0 @@
-export declare function isSummary(raw: unknown): raw is Summary;
-export interface Summary {
-    preview: string;
-    overview: string;
-}

package/dist/core/task/summary.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSummary = void 0;
-function isSummary(raw) {
-    if (typeof raw !== 'object') {
-        return false;
-    }
-    if (raw === null) {
-        return false;
-    }
-    var _a = raw, preview = _a.preview, overview = _a.overview;
-    if (!(typeof preview === 'string' && typeof overview === 'string')) {
-        return false;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    var _ = { preview: preview, overview: overview };
-    return true;
-}
-exports.isSummary = isSummary;

package/dist/core/task/task.d.ts

@@ -1,12 +0,0 @@
-import { DisplayInformation } from './display_information';
-import { TrainingInformation } from './training_information';
-import { Digest } from './digest';
-export declare type TaskID = string;
-export declare function isTaskID(obj: unknown): obj is TaskID;
-export declare function isTask(raw: unknown): raw is Task;
-export interface Task {
-    taskID: TaskID;
-    digest?: Digest;
-    displayInformation: DisplayInformation;
-    trainingInformation: TrainingInformation;
-}

package/dist/core/task/task.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTask = exports.isTaskID = void 0;
-var display_information_1 = require("./display_information");
-var training_information_1 = require("./training_information");
-var digest_1 = require("./digest");
-function isTaskID(obj) {
-    return typeof obj === 'string';
-}
-exports.isTaskID = isTaskID;
-function isTask(raw) {
-    if (typeof raw !== 'object') {
-        return false;
-    }
-    if (raw === null) {
-        return false;
-    }
-    var _a = raw, taskID = _a.taskID, digest = _a.digest, displayInformation = _a.displayInformation, trainingInformation = _a.trainingInformation;
-    if (typeof taskID !== 'string') {
-        return false;
-    }
-    if (digest !== undefined && !(0, digest_1.isDigest)(digest)) {
-        return false;
-    }
-    if (!(0, display_information_1.isDisplayInformation)(displayInformation)) {
-        return false;
-    }
-    if (!(0, training_information_1.isTrainingInformation)(trainingInformation)) {
-        return false;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    var _ = { taskID: taskID, displayInformation: displayInformation, trainingInformation: trainingInformation };
-    return true;
-}
-exports.isTask = isTask;

package/dist/core/task/task_handler.d.ts

@@ -1,5 +0,0 @@
-import { Map } from 'immutable';
-import { tf } from '..';
-import { Task, TaskID } from './task';
-export declare function pushTask(url: URL, task: Task, model: tf.LayersModel): Promise<void>;
-export declare function fetchTasks(url: URL): Promise<Map<TaskID, Task>>;

package/dist/core/task/task_handler.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchTasks = exports.pushTask = void 0;
-var tslib_1 = require("tslib");
-var immutable_1 = require("immutable");
-var axios_1 = (0, tslib_1.__importDefault)(require("axios"));
-var __1 = require("..");
-var task_1 = require("./task");
-var TASK_ENDPOINT = 'tasks';
-function pushTask(url, task, model) {
-    return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-        var _a, _b, _c;
-        var _d;
-        return (0, tslib_1.__generator)(this, function (_e) {
-            switch (_e.label) {
-                case 0:
-                    _b = (_a = axios_1.default).post;
-                    _c = [url.href + TASK_ENDPOINT];
-                    _d = {
-                        task: task
-                    };
-                    return [4 /*yield*/, __1.serialization.model.encode(model)];
-                case 1:
-                    _d.model = _e.sent();
-                    return [4 /*yield*/, __1.serialization.weights.encode(__1.WeightsContainer.from(model))];
-                case 2: return [4 /*yield*/, _b.apply(_a, _c.concat([(_d.weights = _e.sent(),
-                            _d)]))];
-                case 3:
-                    _e.sent();
-                    return [2 /*return*/];
-            }
-        });
-    });
-}
-exports.pushTask = pushTask;
-function fetchTasks(url) {
-    return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-        var response, tasks;
-        return (0, tslib_1.__generator)(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, axios_1.default.get(url.href + TASK_ENDPOINT)];
-                case 1:
-                    response = _a.sent();
-                    tasks = response.data;
-                    if (!Array.isArray(tasks) || !tasks.every(task_1.isTask)) {
-                        throw new Error('invalid tasks response');
-                    }
-                    return [2 /*return*/, (0, immutable_1.Map)(tasks.map(function (t) { return [t.taskID, t]; }))];
-            }
-        });
-    });
-}
-exports.fetchTasks = fetchTasks;

package/dist/core/task/task_provider.d.ts

@@ -1,6 +0,0 @@
-import { tf, Task } from '..';
-export interface TaskProvider {
-    getTask: () => Task;
-    getModel: () => Promise<tf.LayersModel>;
-}
-export declare function isTaskProvider(obj: any): obj is TaskProvider;

package/dist/core/task/task_provider.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTaskProvider = void 0;
-function isTaskProvider(obj) {
-    if ('getModel' in obj && typeof obj.getModel === 'function' &&
-        'getTask' in obj && typeof obj.getTask === 'function') {
-        return true;
-    }
-    else {
-        return false;
-    }
-}
-exports.isTaskProvider = isTaskProvider;

package/dist/core/task/training_information.d.ts

@@ -1,28 +0,0 @@
-import { Preprocessing } from '../dataset/data/preprocessing';
-import { ModelCompileData } from './model_compile_data';
-export declare function isTrainingInformation(raw: unknown): raw is TrainingInformation;
-export interface TrainingInformation {
-    modelID: string;
-    epochs: number;
-    roundDuration: number;
-    validationSplit: number;
-    batchSize: number;
-    preprocessingFunctions?: Preprocessing[];
-    modelCompileData: ModelCompileData;
-    dataType: string;
-    inputColumns?: string[];
-    outputColumns?: string[];
-    IMAGE_H?: number;
-    IMAGE_W?: number;
-    modelURL?: string;
-    LABEL_LIST?: string[];
-    learningRate?: number;
-    scheme: string;
-    noiseScale?: number;
-    clippingRadius?: number;
-    decentralizedSecure?: boolean;
-    byzantineRobustAggregator?: boolean;
-    tauPercentile?: number;
-    maxShareValue?: number;
-    minimumReadyPeers?: number;
-}

package/dist/core/task/training_information.js

@@ -1,66 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTrainingInformation = void 0;
-var model_compile_data_1 = require("./model_compile_data");
-function isTrainingInformation(raw) {
-    if (typeof raw !== 'object') {
-        return false;
-    }
-    if (raw === null) {
-        return false;
-    }
-    var _a = raw, dataType = _a.dataType, scheme = _a.scheme, epochs = _a.epochs, 
-    // roundDuration,
-    validationSplit = _a.validationSplit, batchSize = _a.batchSize, modelCompileData = _a.modelCompileData, modelID = _a.modelID, preprocessingFunctions = _a.preprocessingFunctions, inputColumns = _a.inputColumns, outputColumns = _a.outputColumns, IMAGE_H = _a.IMAGE_H, IMAGE_W = _a.IMAGE_W, roundDuration = _a.roundDuration, modelURL = _a.modelURL, learningRate = _a.learningRate, decentralizedSecure = _a.decentralizedSecure, maxShareValue = _a.maxShareValue, minimumReadyPeers = _a.minimumReadyPeers, LABEL_LIST = _a.LABEL_LIST, noiseScale = _a.noiseScale, clippingRadius = _a.clippingRadius;
-    if (typeof dataType !== 'string' ||
-        typeof modelID !== 'string' ||
-        typeof epochs !== 'number' ||
-        typeof batchSize !== 'number' ||
-        typeof roundDuration !== 'number' ||
-        typeof validationSplit !== 'number' ||
-        (modelURL !== undefined && typeof modelURL !== 'string') ||
-        (noiseScale !== undefined && typeof noiseScale !== 'number') ||
-        (clippingRadius !== undefined && typeof clippingRadius !== 'number') ||
-        (learningRate !== undefined && typeof learningRate !== 'number') ||
-        (decentralizedSecure !== undefined && typeof decentralizedSecure !== 'boolean') ||
-        (maxShareValue !== undefined && typeof maxShareValue !== 'number') ||
-        (minimumReadyPeers !== undefined && typeof minimumReadyPeers !== 'number')) {
-        return false;
-    }
-    // interdepences on data type
-    switch (dataType) {
-        case 'image':
-            if (typeof IMAGE_H !== 'number' || typeof IMAGE_W !== 'number') {
-                return false;
-            }
-            break;
-        case 'tabular':
-            if (!(Array.isArray(inputColumns) && inputColumns.every(function (e) { return typeof e === 'string'; }))) {
-                return false;
-            }
-            if (!(Array.isArray(outputColumns) && outputColumns.every(function (e) { return typeof e === 'string'; }))) {
-                return false;
-            }
-            break;
-    }
-    // interdepences on scheme
-    switch (scheme) {
-        case 'decentralized':
-            break;
-        case 'federated':
-            break;
-        case 'local':
-            break;
-    }
-    if (!(0, model_compile_data_1.isModelCompileData)(modelCompileData)) {
-        return false;
-    }
-    if (LABEL_LIST !== undefined && !(Array.isArray(LABEL_LIST) && LABEL_LIST.every(function (e) { return typeof e === 'string'; }))) {
-        return false;
-    }
-    if (preprocessingFunctions !== undefined && !(Array.isArray(preprocessingFunctions) && preprocessingFunctions.every(function (e) { return typeof e === 'string'; }))) {
-        return false;
-    }
-    return true;
-}
-exports.isTrainingInformation = isTrainingInformation;

package/dist/core/training/disco.d.ts

@@ -1,23 +0,0 @@
-import { Client, data, Logger, Task, TrainingInformant, TrainingSchemes, Memory } from '..';
-import { TrainerLog } from '../logging/trainer_logger';
-interface DiscoOptions {
-    client?: Client;
-    url?: string | URL;
-    scheme?: TrainingSchemes;
-    informant?: TrainingInformant;
-    logger?: Logger;
-    memory?: Memory;
-}
-export declare class Disco {
-    readonly task: Task;
-    readonly logger: Logger;
-    readonly memory: Memory;
-    private readonly client;
-    private readonly trainer;
-    constructor(task: Task, options: DiscoOptions);
-    fit(dataTuple: data.DataSplit): Promise<void>;
-    pause(): Promise<void>;
-    close(): Promise<void>;
-    logs(): Promise<TrainerLog>;
-}
-export {};