@epfml/discojs 0.0.1 → 0.1.0

package/dist/client/decentralized.js

@@ -1,275 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Decentralized = void 0;
-var tslib_1 = require("tslib");
-var immutable_1 = require("immutable");
-var isomorphic_ws_1 = (0, tslib_1.__importDefault)(require("isomorphic-ws"));
-var msgpack_lite_1 = (0, tslib_1.__importDefault)(require("msgpack-lite"));
-var simple_peer_1 = (0, tslib_1.__importDefault)(require("simple-peer"));
-var url_1 = require("url");
-var __1 = require("..");
-var base_1 = require("./base");
-function isPeerMessage(data) {
-    if (typeof data !== 'object') {
-        return false;
-    }
-    if (data === null) {
-        return false;
-    }
-    if (!(0, immutable_1.Set)(Object.keys(data)).equals(immutable_1.Set.of('epoch', 'weights'))) {
-        return false;
-    }
-    var _a = data, epoch = _a.epoch, weights = _a.weights;
-    if (typeof epoch !== 'number' ||
-        !__1.serialization.weights.isEncoded(weights)) {
-        return false;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    var _ = { epoch: epoch, weights: weights };
-    return true;
-}
-function isServerOpeningMessage(msg) {
-    if (!(msg instanceof Array)) {
-        return false;
-    }
-    if (!msg.every(function (elem) { return typeof elem === 'number'; })) {
-        return false;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    var _ = msg;
-    return true;
-}
-function isServerPeerMessage(msg) {
-    if (!(msg instanceof Array)) {
-        return false;
-    }
-    if (msg.length !== 2) {
-        return false;
-    }
-    var _a = (0, tslib_1.__read)(msg, 2), id = _a[0], signal = _a[1];
-    if (typeof id !== 'number') {
-        return false;
-    }
-    if (!(signal instanceof Uint8Array)) {
-        return false;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    var _ = [id, signal];
-    return true;
-}
-// Time to wait between network checks in milliseconds.
-var TICK = 100;
-// Time to wait for the others in milliseconds.
-var MAX_WAIT_PER_ROUND = 10000;
-/**
- * Class that deals with communication with the PeerJS server.
- * Collects the list of receivers currently connected to the PeerJS server.
- */
-var Decentralized = /** @class */ (function (_super) {
-    (0, tslib_1.__extends)(Decentralized, _super);
-    function Decentralized() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.peers = (0, immutable_1.Map)();
-        _this.weights = (0, immutable_1.Map)();
-        return _this;
-    }
-    Decentralized.prototype.connectServer = function (url) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            var ws;
-            var _this = this;
-            return (0, tslib_1.__generator)(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        ws = new isomorphic_ws_1.default.WebSocket(url);
-                        ws.binaryType = 'arraybuffer';
-                        ws.onmessage = function (event) {
-                            if (!(event.data instanceof ArrayBuffer)) {
-                                throw new Error('server did not send an ArrayBuffer');
-                            }
-                            var msg = msgpack_lite_1.default.decode(new Uint8Array(event.data));
-                            if (isServerOpeningMessage(msg)) {
-                                console.debug('server sent us the list of peer to connect to:', msg);
-                                if (_this.peers.size !== 0) {
-                                    throw new Error('server already gave us a list of peers');
-                                }
-                                _this.peers = (0, immutable_1.Map)((0, immutable_1.List)(msg)
-                                    .map(function (id) { return [id, _this.connectNewPeer(id, true)]; }));
-                            }
-                            else if (isServerPeerMessage(msg)) {
-                                var _a = (0, tslib_1.__read)(msg, 2), peerID = _a[0], encodedSignal = _a[1];
-                                var signal = msgpack_lite_1.default.decode(encodedSignal);
-                                console.debug('server on behalf of', peerID, 'sent', signal);
-                                var peer = _this.peers.get(peerID);
-                                if (peer === undefined) {
-                                    peer = _this.connectNewPeer(peerID, false);
-                                    _this.peers = _this.peers.set(peerID, peer);
-                                }
-                                peer.signal(signal);
-                            }
-                            else {
-                                throw new Error('send sent an invalid msg');
-                            }
-                        };
-                        return [4 /*yield*/, new Promise(function (resolve, reject) {
-                                ws.onerror = function (err) { return reject(new Error("connecting server: " + err)); };
-                                ws.onopen = function () { return resolve(ws); };
-                            })];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    // connect a new peer
-    //
-    // if initiator is true, we start the connection on our side
-    // see SimplePeer.Options.initiator for more info
-    Decentralized.prototype.connectNewPeer = function (peerID, initiator) {
-        var _this = this;
-        console.debug('connect new peer with initiator: ', initiator);
-        var peer = new simple_peer_1.default({
-            initiator: initiator,
-            config: {
-                iceServers: (0, immutable_1.List)(simple_peer_1.default.config.iceServers)
-                    /* .push({
-                      urls: 'turn:34.77.172.69:3478',
-                      credential: 'deai',
-                      username: 'deai'
-                    }) */
-                    .toArray()
-            }
-        });
-        peer.on('signal', function (signal) {
-            console.debug('local', peerID, 'is signaling', signal);
-            if (_this.server === undefined) {
-                throw new Error('server closed but received a signal');
-            }
-            var msg = [peerID, msgpack_lite_1.default.encode(signal)];
-            _this.server.send(msgpack_lite_1.default.encode(msg));
-        });
-        peer.on('data', function (data) {
-            var _a;
-            var message = msgpack_lite_1.default.decode(data);
-            if (!isPeerMessage(message)) {
-                throw new Error("invalid message received from " + peerID);
-            }
-            var weights = __1.serialization.weights.decode(message.weights);
-            console.debug('peer', peerID, 'sent weights', weights);
-            if (((_a = _this.weights.get(peer)) === null || _a === void 0 ? void 0 : _a.get(message.epoch)) !== undefined) {
-                throw new Error("weights from " + peerID + " already received");
-            }
-            _this.weights.set(peer, _this.weights.get(peer, (0, immutable_1.List)())
-                .set(message.epoch, weights));
-        });
-        peer.on('connect', function () { return console.info('connected to peer', peerID); });
-        // TODO better error handling
-        peer.on('error', function (err) { throw err; });
-        return peer;
-    };
-    /**
-     * Initialize the connection to the peers and to the other nodes.
-     */
-    Decentralized.prototype.connect = function () {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            var serverURL, _a;
-            return (0, tslib_1.__generator)(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        serverURL = new url_1.URL('', this.url.href);
-                        serverURL.pathname += "/deai/tasks/" + this.task.taskID;
-                        _a = this;
-                        return [4 /*yield*/, this.connectServer(serverURL)];
-                    case 1:
-                        _a.server = _b.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Disconnection process when user quits the task.
-     */
-    Decentralized.prototype.disconnect = function () {
-        var _a;
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            return (0, tslib_1.__generator)(this, function (_b) {
-                this.peers.forEach(function (peer) { return peer.destroy(); });
-                this.peers = (0, immutable_1.Map)();
-                (_a = this.server) === null || _a === void 0 ? void 0 : _a.close();
-                this.server = undefined;
-                return [2 /*return*/];
-            });
-        });
-    };
-    Decentralized.prototype.onRoundEndCommunication = function (updatedWeights, staleWeights, epoch, trainingInformant) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            var noisyWeights, msg, encodedMsg, getWeights, timeoutError, receivedWeights;
-            var _a;
-            var _this = this;
-            return (0, tslib_1.__generator)(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        noisyWeights = __1.privacy.addDifferentialPrivacy(updatedWeights, staleWeights, this.task);
-                        _a = {
-                            epoch: epoch
-                        };
-                        return [4 /*yield*/, __1.serialization.weights.encode(noisyWeights)];
-                    case 1:
-                        msg = (_a.weights = _b.sent(),
-                            _a);
-                        encodedMsg = msgpack_lite_1.default.encode(msg);
-                        this.peers
-                            .filter(function (peer) { return peer.connected; })
-                            .forEach(function (peer, peerID) {
-                            trainingInformant.addMessage("Sending weights to peer " + peerID);
-                            trainingInformant.updateWhoReceivedMyModel("peer " + peerID);
-                            peer.send(encodedMsg);
-                        });
-                        getWeights = function () {
-                            return _this.weights
-                                .valueSeq()
-                                .map(function (epochesWeights) { return epochesWeights.get(epoch); });
-                        };
-                        timeoutError = new Error('timeout');
-                        return [4 /*yield*/, new Promise(function (resolve, reject) {
-                                var interval = setInterval(function () {
-                                    var gotAllWeights = getWeights().every(function (weights) { return weights !== undefined; });
-                                    if (gotAllWeights) {
-                                        clearInterval(interval);
-                                        resolve();
-                                    }
-                                }, TICK);
-                                setTimeout(function () {
-                                    clearInterval(interval);
-                                    reject(timeoutError);
-                                }, MAX_WAIT_PER_ROUND);
-                            }).catch(function (err) {
-                                if (err !== timeoutError) {
-                                    throw err;
-                                }
-                            })];
-                    case 2:
-                        _b.sent();
-                        receivedWeights = getWeights()
-                            .filter(function (weights) { return weights !== undefined; })
-                            .toSet();
-                        // Average weights
-                        trainingInformant.addMessage('Averaging weights');
-                        trainingInformant.updateNbrUpdatesWithOthers(1);
-                        // Return the new "received" weights
-                        return [2 /*return*/, __1.aggregation.averageWeights(receivedWeights)];
-                }
-            });
-        });
-    };
-    Decentralized.prototype.onTrainEndCommunication = function (_, trainingInformant) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            return (0, tslib_1.__generator)(this, function (_a) {
-                // TODO: enter seeding mode?
-                trainingInformant.addMessage('Training finished.');
-                return [2 /*return*/];
-            });
-        });
-    };
-    return Decentralized;
-}(base_1.Base));
-exports.Decentralized = Decentralized;

package/dist/testing/tester.d.ts

@@ -1,5 +0,0 @@
-import { ModelActor } from '../model_actor';
-export declare class Tester extends ModelActor {
-    testModel(): Promise<boolean>;
-}
-export default Tester;

package/dist/testing/tester.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Tester = void 0;
-var tslib_1 = require("tslib");
-var model_actor_1 = require("../model_actor");
-var Tester = /** @class */ (function (_super) {
-    (0, tslib_1.__extends)(Tester, _super);
-    function Tester() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    Tester.prototype.testModel = function () {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            return (0, tslib_1.__generator)(this, function (_a) {
-                return [2 /*return*/, true];
-            });
-        });
-    };
-    return Tester;
-}(model_actor_1.ModelActor));
-exports.Tester = Tester;
-exports.default = Tester;

package/dist/training_informant.d.ts

@@ -1,88 +0,0 @@
-import { List, Set } from 'immutable';
-import { TaskID } from '.';
-import { TrainingSchemes } from './training/training_schemes';
-/**
- * Class that collects information about the status of the training-loop of the model.
- */
-export declare class TrainingInformant {
-    private readonly nbrMessagesToShow;
-    readonly taskID: TaskID;
-    readonly taskTrainingScheme: TrainingSchemes;
-    whoReceivedMyModel: Set<unknown>;
-    nbrUpdatesWithOthers: number;
-    waitingTime: number;
-    nbrWeightRequests: number;
-    messages: List<unknown>;
-    currentRound: number;
-    currentNumberOfParticipants: number;
-    totalNumberOfParticipants: number;
-    averageNumberOfParticipants: number;
-    validationAccuracyChart: unknown;
-    validationAccuracy: number;
-    trainingAccuracyChart: unknown;
-    trainingAccuracy: number;
-    displayHeatmap: boolean;
-    currentValidationAccuracy: number;
-    validationAccuracyDataSerie: List<number>;
-    currentTrainingAccuracy: number;
-    trainingAccuracyDataSerie: List<number>;
-    weightsIn: number;
-    weightsOut: number;
-    /**
-     *
-     * @param nbrMessagesToShow the number of messages to be kept to inform the users about status of communication with other peers.
-     * @param taskID the task's name.
-     */
-    constructor(nbrMessagesToShow: number, taskID: TaskID, taskTrainingScheme: TrainingSchemes);
-    /**
-     * Updates the set of peers who received my model.
-     * @param {String} peerName the peer's name to whom I recently shared my model to.
-     */
-    updateWhoReceivedMyModel(peerName: string): void;
-    /**
-     * Updates the number of updates I did with other peers.
-     * @param {Number} nbrUpdates the number of updates I did thanks to other peers contribution since the last update of the parameter.
-     */
-    updateNbrUpdatesWithOthers(nbrUpdates: number): void;
-    /**
-     * Updates the time I waited to receive weights.
-     * @param {Number} time
-     */
-    updateWaitingTime(time: number): void;
-    /**
-     * Updates the number of weights request I received.
-     * @param {Number} nbrRequests the number of weight requests I received since the last update of the parameter.
-     */
-    updateNbrWeightsRequests(nbrRequests: number): void;
-    /**
-     * Add a new message to the message list.
-     * @param {String} msg a message.
-     */
-    addMessage(msg: string): void;
-    /**
-     * Update the server statistics with the JSON received from the server
-     * For now it's just the JSON, but we might want to keep it as a dictionnary
-     * @param {any} receivedStatistics statistics received from the server.
-     */
-    updateWithServerStatistics(receivedStatistics: Record<string, number>): void;
-    /**
-     *  Updates the data to be displayed on the validation accuracy graph.
-     * @param {Number} validationAccuracy the current validation accuracy of the model
-     */
-    updateValidationAccuracyGraph(validationAccuracy: number): void;
-    /**
-     * Returns wether or not the Task's training scheme is Decentralized
-     * @returns Boolean value
-     */
-    isTaskTrainingSchemeDecentralized(): boolean;
-    /**
-     * Returns wether or not the Task's training scheme is Federated
-     * @returns Boolean value
-     */
-    isTaskTrainingSchemeFederated(): boolean;
-    /**
-     *  Updates the data to be displayed on the training accuracy graph.
-     * @param {Number} trainingAccuracy the current training accuracy of the model
-     */
-    updateTrainingAccuracyGraph(trainingAccuracy: number): void;
-}

package/dist/training_informant.js

@@ -1,135 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TrainingInformant = void 0;
-var immutable_1 = require("immutable");
-var training_schemes_1 = require("./training/training_schemes");
-var nbEpochsOnGraphs = 10;
-/**
- * Class that collects information about the status of the training-loop of the model.
- */
-var TrainingInformant = /** @class */ (function () {
-    /**
-     *
-     * @param nbrMessagesToShow the number of messages to be kept to inform the users about status of communication with other peers.
-     * @param taskID the task's name.
-     */
-    function TrainingInformant(nbrMessagesToShow, taskID, taskTrainingScheme) {
-        this.nbrMessagesToShow = nbrMessagesToShow;
-        this.taskID = taskID;
-        this.taskTrainingScheme = taskTrainingScheme;
-        // Decentralized Informations
-        // number of people with whom I've shared my model
-        this.whoReceivedMyModel = (0, immutable_1.Set)();
-        // message feedback from peer-to-peer training
-        this.messages = (0, immutable_1.List)();
-        this.validationAccuracyDataSerie = (0, immutable_1.Repeat)(0, nbEpochsOnGraphs).toList();
-        this.trainingAccuracyDataSerie = (0, immutable_1.Repeat)(0, nbEpochsOnGraphs).toList();
-        this.weightsIn = 0;
-        this.weightsOut = 0;
-        // how many times the model has been averaged with someone's else model
-        this.nbrUpdatesWithOthers = 0;
-        // how much time I've been waiting for a model
-        this.waitingTime = 0;
-        // number of weight requests I've responded to
-        this.nbrWeightRequests = 0;
-        // statistics received from the server
-        this.currentRound = 0;
-        this.currentNumberOfParticipants = 0;
-        this.totalNumberOfParticipants = 0;
-        this.averageNumberOfParticipants = 0;
-        // validation accuracy chart
-        this.validationAccuracyChart = null; // new TrainingChart("validationAccuracy_".concat(taskID), "Validation Accuracy")
-        this.validationAccuracy = 0;
-        // training accuracy chart
-        this.trainingAccuracyChart = null; // new TrainingChart("trainingAccuracy_".concat(taskID), "Training Accuracy")
-        this.trainingAccuracy = 0;
-        // is the model using Interoperability (default to false)
-        this.displayHeatmap = false;
-        // default values for the validation and training charts
-        this.currentValidationAccuracy = 0;
-        this.currentTrainingAccuracy = 0;
-    }
-    /**
-     * Updates the set of peers who received my model.
-     * @param {String} peerName the peer's name to whom I recently shared my model to.
-     */
-    TrainingInformant.prototype.updateWhoReceivedMyModel = function (peerName) {
-        this.whoReceivedMyModel = this.whoReceivedMyModel.add(peerName);
-    };
-    /**
-     * Updates the number of updates I did with other peers.
-     * @param {Number} nbrUpdates the number of updates I did thanks to other peers contribution since the last update of the parameter.
-     */
-    TrainingInformant.prototype.updateNbrUpdatesWithOthers = function (nbrUpdates) {
-        this.nbrUpdatesWithOthers += nbrUpdates;
-    };
-    /**
-     * Updates the time I waited to receive weights.
-     * @param {Number} time
-     */
-    TrainingInformant.prototype.updateWaitingTime = function (time) {
-        this.waitingTime += time;
-    };
-    /**
-     * Updates the number of weights request I received.
-     * @param {Number} nbrRequests the number of weight requests I received since the last update of the parameter.
-     */
-    TrainingInformant.prototype.updateNbrWeightsRequests = function (nbrRequests) {
-        this.nbrWeightRequests += nbrRequests;
-    };
-    /**
-     * Add a new message to the message list.
-     * @param {String} msg a message.
-     */
-    TrainingInformant.prototype.addMessage = function (msg) {
-        if (this.messages.size >= this.nbrMessagesToShow) {
-            this.messages = this.messages.shift();
-        }
-        this.messages = this.messages.push(msg);
-    };
-    /**
-     * Update the server statistics with the JSON received from the server
-     * For now it's just the JSON, but we might want to keep it as a dictionnary
-     * @param {any} receivedStatistics statistics received from the server.
-     */
-    TrainingInformant.prototype.updateWithServerStatistics = function (receivedStatistics) {
-        this.currentRound = receivedStatistics.round;
-        this.currentNumberOfParticipants = receivedStatistics.currentNumberOfParticipants;
-        this.totalNumberOfParticipants = receivedStatistics.totalNumberOfParticipants;
-        this.averageNumberOfParticipants = receivedStatistics.averageNumberOfParticipants;
-    };
-    /**
-     *  Updates the data to be displayed on the validation accuracy graph.
-     * @param {Number} validationAccuracy the current validation accuracy of the model
-     */
-    TrainingInformant.prototype.updateValidationAccuracyGraph = function (validationAccuracy) {
-        this.validationAccuracyDataSerie =
-            this.validationAccuracyDataSerie.shift().push(validationAccuracy);
-        this.currentValidationAccuracy = validationAccuracy;
-    };
-    /**
-     * Returns wether or not the Task's training scheme is Decentralized
-     * @returns Boolean value
-     */
-    TrainingInformant.prototype.isTaskTrainingSchemeDecentralized = function () {
-        return this.taskTrainingScheme === training_schemes_1.TrainingSchemes.DECENTRALIZED;
-    };
-    /**
-     * Returns wether or not the Task's training scheme is Federated
-     * @returns Boolean value
-     */
-    TrainingInformant.prototype.isTaskTrainingSchemeFederated = function () {
-        return this.taskTrainingScheme === training_schemes_1.TrainingSchemes.FEDERATED;
-    };
-    /**
-     *  Updates the data to be displayed on the training accuracy graph.
-     * @param {Number} trainingAccuracy the current training accuracy of the model
-     */
-    TrainingInformant.prototype.updateTrainingAccuracyGraph = function (trainingAccuracy) {
-        this.trainingAccuracyDataSerie =
-            this.trainingAccuracyDataSerie.shift().push(trainingAccuracy);
-        this.currentTrainingAccuracy = trainingAccuracy;
-    };
-    return TrainingInformant;
-}());
-exports.TrainingInformant = TrainingInformant;