@epfml/discojs 1.0.0 → 2.1.1

package/dist/tasks/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.titanic = exports.simple_face = exports.mnist = exports.lus_covid = exports.cifar10 = void 0;
-var tslib_1 = require("tslib");
-exports.cifar10 = (0, tslib_1.__importStar)(require("./cifar10"));
-exports.lus_covid = (0, tslib_1.__importStar)(require("./lus_covid"));
-exports.mnist = (0, tslib_1.__importStar)(require("./mnist"));
-exports.simple_face = (0, tslib_1.__importStar)(require("./simple_face"));
-exports.titanic = (0, tslib_1.__importStar)(require("./titanic"));

package/dist/tasks/lus_covid.d.ts

@@ -1,4 +0,0 @@
-import * as tf from '@tensorflow/tfjs';
-import { Task } from '../task';
-export declare const task: Task;
-export declare function model(imageHeight?: number, imageWidth?: number, imageChannels?: number, numOutputClasses?: number): tf.LayersModel;

package/dist/tasks/lus_covid.js

@@ -1,85 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.model = exports.task = void 0;
-var tslib_1 = require("tslib");
-var tf = (0, tslib_1.__importStar)(require("@tensorflow/tfjs"));
-exports.task = {
-    taskID: 'lus_covid',
-    displayInformation: {
-        taskTitle: 'COVID Lung Ultrasound',
-        summary: {
-            preview: "Do you have a dataset of lung ultrasound images on patients <b>suspected of Lower Respiratory Tract infection (LRTI) during the COVID pandemic</b>? <br> Learn how to discriminate between COVID positive and negative patients by joining this task. <br><br> Don’t have a dataset of your own? Download a sample of a few cases <a class='underline' href='https://drive.switch.ch/index.php/s/zM5ZrUWK3taaIly'>here</a>.",
-            overview: "Do you have a dataset of lung ultrasound images on patients <b>suspected of Lower Respiratory Tract infection (LRTI) during the COVID pandemic</b>? <br> Learn how to discriminate between COVID positive and negative patients by joining this task. <br><br> Don’t have a dataset of your own? Download a sample of a few cases <a class='underline' href='https://drive.switch.ch/index.php/s/zM5ZrUWK3taaIly'>here</a>."
-        },
-        model: "We use a simplified* version of the <b>DeepChest model</b>: A deep learning model developed in our lab (<a class='underline' href='https://www.epfl.ch/labs/mlo/igh-intelligent-global-health/'>intelligent Global Health</a>.). On a cohort of 400 Swiss patients suspected of LRTI, the model obtained over 90% area under the ROC curve for this task. <br><br>*Simplified to ensure smooth running on your browser, the performance is minimally affected. Details of the adaptations are below <br>- <b>Removed</b>: positional embedding (i.e. we don’t take the anatomic position into consideration). Rather, the model now does mean pooling over the feature vector of the images for each patient <br>- <b>Replaced</b>: ResNet18 by Mobilenet",
-        tradeoffs: 'We are using a simpler version of DeepChest in order to be able to run it on the browser.',
-        dataFormatInformation: 'This model takes as input an image dataset. It consists on a set of lung ultrasound images per patient with its corresponding label of covid positive or negative. Moreover, to identify the images per patient you have to follow the follwing naming pattern: "patientId_*.png"',
-        dataExampleText: 'Below you can find an example of an expected lung image for patient 2 named: 2_QAID_1.masked.reshaped.squared.224.png'
-    },
-    trainingInformation: {
-        modelID: 'lus-covid-model',
-        epochs: 15,
-        roundDuration: 10,
-        validationSplit: 0.2,
-        batchSize: 2,
-        modelCompileData: {
-            optimizer: 'sgd',
-            loss: 'binaryCrossentropy',
-            metrics: ['accuracy']
-        },
-        learningRate: 0.001,
-        threshold: 2,
-        IMAGE_H: 100,
-        IMAGE_W: 100,
-        preprocessFunctions: [],
-        LABEL_LIST: ['COVID-Positive', 'COVID-Negative'],
-        NUM_CLASSES: 2,
-        dataType: 'image',
-        aggregateImagesById: true,
-        scheme: 'Decentralized'
-    }
-};
-function model(imageHeight, imageWidth, imageChannels, numOutputClasses) {
-    if (imageHeight === void 0) { imageHeight = 100; }
-    if (imageWidth === void 0) { imageWidth = 100; }
-    if (imageChannels === void 0) { imageChannels = 3; }
-    if (numOutputClasses === void 0) { numOutputClasses = 2; }
-    var model = tf.sequential();
-    // In the first layer of our convolutional neural network we have
-    // to specify the input shape. Then we specify some parameters for
-    // the convolution operation that takes place in this layer.
-    model.add(tf.layers.conv2d({
-        inputShape: [imageHeight, imageWidth, imageChannels],
-        kernelSize: 5,
-        filters: 8,
-        strides: 1,
-        activation: 'relu',
-        kernelInitializer: 'varianceScaling'
-    }));
-    // The MaxPooling layer acts as a sort of downsampling using max values
-    // in a region instead of averaging.
-    model.add(tf.layers.maxPooling2d({ poolSize: [2, 2], strides: [2, 2] }));
-    // Repeat another conv2d + maxPooling stack.
-    // Note that we have more filters in the convolution.
-    model.add(tf.layers.conv2d({
-        kernelSize: 5,
-        filters: 16,
-        strides: 1,
-        activation: 'relu',
-        kernelInitializer: 'varianceScaling'
-    }));
-    model.add(tf.layers.maxPooling2d({ poolSize: [2, 2], strides: [2, 2] }));
-    // Now we flatten the output from the 2D filters into a 1D vector to prepare
-    // it for input into our last layer. This is common practice when feeding
-    // higher dimensional data to a final classification output layer.
-    model.add(tf.layers.flatten());
-    // Our last layer is a dense layer which has 10 output units, one for each
-    // output class (i.e. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9).
-    model.add(tf.layers.dense({
-        units: numOutputClasses,
-        kernelInitializer: 'varianceScaling',
-        activation: 'softmax'
-    }));
-    return model;
-}
-exports.model = model;

package/dist/tasks/mnist.d.ts

@@ -1,4 +0,0 @@
-import * as tf from '@tensorflow/tfjs';
-import { Task } from '../task';
-export declare const task: Task;
-export declare function model(): tf.LayersModel;

package/dist/tasks/mnist.js

@@ -1,58 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.model = exports.task = void 0;
-var tslib_1 = require("tslib");
-var tf = (0, tslib_1.__importStar)(require("@tensorflow/tfjs"));
-exports.task = {
-    taskID: 'mnist',
-    displayInformation: {
-        taskTitle: 'MNIST',
-        summary: {
-            preview: "Test our platform by using a publicly available <b>image</b> dataset. <br><br> Download the classic MNIST imagebank of hand-written numbers <a class='underline text-primary-dark dark:text-primary-light' href='https://www.kaggle.com/scolianni/mnistasjpg'>here</a>. <br> This model learns to identify hand written numbers.",
-            overview: 'The MNIST handwritten digit classification problem is a standard dataset used in computer vision and deep learning. Although the dataset is effectively solved, we use it to test our Decentralised Learning algorithms and platform.'
-        },
-        model: 'The current model is a very simple CNN and its main goal is to test the app and the Decentralizsed Learning functionality.',
-        tradeoffs: 'We are using a simple model, first a 2d convolutional layer > max pooling > 2d convolutional layer > max pooling > convolutional layer > 2 dense layers.',
-        dataFormatInformation: 'This model is trained on images corresponding to digits 0 to 9. You can upload each digit image of your dataset in the box corresponding to its label. The model taskes images of size 28x28 as input.',
-        dataExampleText: 'Below you can find an example of an expected image representing the digit 9.',
-        dataExampleImage: './9-mnist-example.png'
-    },
-    trainingInformation: {
-        modelID: 'mnist-model',
-        epochs: 10,
-        roundDuration: 10,
-        validationSplit: 0.2,
-        batchSize: 30,
-        modelCompileData: {
-            optimizer: 'rmsprop',
-            loss: 'categoricalCrossentropy',
-            metrics: ['accuracy']
-        },
-        threshold: 1,
-        dataType: 'image',
-        IMAGE_H: 28,
-        IMAGE_W: 28,
-        preprocessFunctions: [],
-        LABEL_LIST: ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9'],
-        aggregateImagesById: false,
-        scheme: 'Decentralized'
-    }
-};
-function model() {
-    var model = tf.sequential();
-    model.add(tf.layers.conv2d({
-        inputShape: [28, 28, 3],
-        kernelSize: 3,
-        filters: 16,
-        activation: 'relu'
-    }));
-    model.add(tf.layers.maxPooling2d({ poolSize: 2, strides: 2 }));
-    model.add(tf.layers.conv2d({ kernelSize: 3, filters: 32, activation: 'relu' }));
-    model.add(tf.layers.maxPooling2d({ poolSize: 2, strides: 2 }));
-    model.add(tf.layers.conv2d({ kernelSize: 3, filters: 32, activation: 'relu' }));
-    model.add(tf.layers.flatten({}));
-    model.add(tf.layers.dense({ units: 64, activation: 'relu' }));
-    model.add(tf.layers.dense({ units: 10, activation: 'softmax' }));
-    return model;
-}
-exports.model = model;

package/dist/tasks/simple_face.d.ts

@@ -1,4 +0,0 @@
-import * as tf from '@tensorflow/tfjs';
-import { Task } from '../task';
-export declare const task: Task;
-export declare function model(imageHeight?: number, imageWidth?: number, imageChannels?: number, numOutputClasses?: number): tf.LayersModel;

package/dist/tasks/simple_face.js

@@ -1,84 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.model = exports.task = void 0;
-var tslib_1 = require("tslib");
-var tf = (0, tslib_1.__importStar)(require("@tensorflow/tfjs"));
-exports.task = {
-    taskID: 'simple_face',
-    displayInformation: {
-        taskTitle: 'Simple Face',
-        summary: {
-            preview: 'Can you detect if the person in a picture is a child or an adult?',
-            overview: 'Simple face is a small subset of face_task from Kaggle'
-        },
-        limitations: 'The training data is limited to small images of size 200x200.',
-        tradeoffs: 'Training success strongly depends on label distribution',
-        dataFormatInformation: '',
-        dataExampleText: 'Below you find an example',
-        dataExampleImage: './simple_face-example.png'
-    },
-    trainingInformation: {
-        modelID: 'simple_face-model',
-        epochs: 50,
-        roundDuration: 1,
-        validationSplit: 0.2,
-        batchSize: 10,
-        preprocessFunctions: [],
-        learningRate: 0.001,
-        modelCompileData: {
-            optimizer: 'sgd',
-            loss: 'categoricalCrossentropy',
-            metrics: ['accuracy']
-        },
-        dataType: 'image',
-        csvLabels: false,
-        IMAGE_H: 200,
-        IMAGE_W: 200,
-        LABEL_LIST: ['child', 'adult'],
-        scheme: 'Federated'
-    }
-};
-function model(imageHeight, imageWidth, imageChannels, numOutputClasses) {
-    if (imageHeight === void 0) { imageHeight = 200; }
-    if (imageWidth === void 0) { imageWidth = 200; }
-    if (imageChannels === void 0) { imageChannels = 3; }
-    if (numOutputClasses === void 0) { numOutputClasses = 2; }
-    var model = tf.sequential();
-    // In the first layer of our convolutional neural network we have
-    // to specify the input shape. Then we specify some parameters for
-    // the convolution operation that takes place in this layer.
-    model.add(tf.layers.conv2d({
-        inputShape: [imageHeight, imageWidth, imageChannels],
-        kernelSize: 5,
-        filters: 8,
-        strides: 1,
-        activation: 'relu',
-        kernelInitializer: 'varianceScaling'
-    }));
-    // The MaxPooling layer acts as a sort of downsampling using max values
-    // in a region instead of averaging.
-    model.add(tf.layers.maxPooling2d({ poolSize: [2, 2], strides: [2, 2] }));
-    // Repeat another conv2d + maxPooling stack.
-    // Note that we have more filters in the convolution.
-    model.add(tf.layers.conv2d({
-        kernelSize: 5,
-        filters: 16,
-        strides: 1,
-        activation: 'relu',
-        kernelInitializer: 'varianceScaling'
-    }));
-    model.add(tf.layers.maxPooling2d({ poolSize: [2, 2], strides: [2, 2] }));
-    // Now we flatten the output from the 2D filters into a 1D vector to prepare
-    // it for input into our last layer. This is common practice when feeding
-    // higher dimensional data to a final classification output layer.
-    model.add(tf.layers.flatten());
-    // Our last layer is a dense layer which has 10 output units, one for each
-    // output class (i.e. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9).
-    model.add(tf.layers.dense({
-        units: numOutputClasses,
-        kernelInitializer: 'varianceScaling',
-        activation: 'softmax'
-    }));
-    return model;
-}
-exports.model = model;

package/dist/tasks/titanic.d.ts

@@ -1,4 +0,0 @@
-import * as tf from '@tensorflow/tfjs';
-import { Task } from '..';
-export declare const task: Task;
-export declare function model(): tf.LayersModel;

package/dist/tasks/titanic.js

@@ -1,88 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.model = exports.task = void 0;
-var tslib_1 = require("tslib");
-var tf = (0, tslib_1.__importStar)(require("@tensorflow/tfjs"));
-exports.task = {
-    taskID: 'titanic',
-    displayInformation: {
-        taskTitle: 'Titanic',
-        summary: {
-            preview: "Test our platform by using a publicly available <b>tabular</b> dataset. <br><br> Download the passenger list from the Titanic shipwreck here: <a class='underline text-primary-dark dark:text-primary-light' href='http://s3.amazonaws.com/assets.datacamp.com/course/Kaggle/train.csv'>train.csv</a> and <a class='underline text-primary-dark dark:text-primary-light' href='http://s3.amazonaws.com/assets.datacamp.com/course/Kaggle/train.csv'>test.csv</a> (more info <a class='underline text-primary-dark dark:text-primary-light' href='https://www.kaggle.com/c/titanic'>here</a>). <br> This model predicts the type of person most likely to survive/die in the historic ship accident, based on their characteristics (sex, age, class etc.).",
-            overview: 'We all know the unfortunate story of the Titanic: this flamboyant new transatlantic boat that sunk in 1912 in the North Atlantic Ocean. Today, we revist this tragedy by trying to predict the survival odds of the passenger given some basic features.'
-        },
-        model: 'The current model does not normalize the given data and applies only a very simple pre-processing of the data.',
-        tradeoffs: 'We are using a small model for this task: 4 fully connected layers with few neurons. This allows fast training but can yield to reduced accuracy.',
-        dataFormatInformation: 'This model takes as input a CSV file with 12 columns. The features are general information about the passenger (sex, age, name, etc.) and specific related Titanic data such as the ticket class bought by the passenger, its cabin number, etc.<br><br>pclass: A proxy for socio-economic status (SES)<br>1st = Upper<br>2nd = Middle<br>3rd = Lower<br><br>age: Age is fractional if less than 1. If the age is estimated, it is in the form of xx.5<br><br>sibsp: The dataset defines family relations in this way:<br>Sibling = brother, sister, stepbrother, stepsister<br>Spouse = husband, wife (mistresses and fiancés were ignored)<br><br>parch: The dataset defines family relations in this way:<br>Parent = mother, father<br>Child = daughter, son, stepdaughter, stepson<br>Some children travelled only with a nanny, therefore parch=0 for them.<br><br>The first line of the CSV contains the header:<br> PassengerId, Survived, Pclass, Name, Sex, Age, SibSp, Parch, Ticket, Fare, Cabin, Embarked<br><br>Each susequent row contains the corresponding data.',
-        dataExampleText: 'Below one can find an example of a datapoint taken as input by our model. In this datapoint, the person is young man named Owen Harris that unfortunnalty perished with the Titanic. He boarded the boat in South Hamptons and was a 3rd class passenger. On the testing & validation page, the data should not contain the label column (Survived).',
-        dataExample: [
-            { columnName: 'PassengerId', columnData: '1' },
-            { columnName: 'Survived', columnData: '0' },
-            { columnName: 'Name', columnData: 'Braund, Mr. Owen Harris' },
-            { columnName: 'Sex', columnData: 'male' },
-            { columnName: 'Age', columnData: '22' },
-            { columnName: 'SibSp', columnData: '1' },
-            { columnName: 'Parch', columnData: '0' },
-            { columnName: 'Ticket', columnData: '1/5 21171' },
-            { columnName: 'Fare', columnData: '7.25' },
-            { columnName: 'Cabin', columnData: 'E46' },
-            { columnName: 'Embarked', columnData: 'S' },
-            { columnName: 'Pclass', columnData: '3' }
-        ],
-        headers: [
-            'PassengerId',
-            'Survived',
-            'Name',
-            'Sex',
-            'Age',
-            'SibSp',
-            'Parch',
-            'Ticket',
-            'Fare',
-            'Cabin',
-            'Embarked',
-            'Pclass'
-        ]
-    },
-    trainingInformation: {
-        modelID: 'titanic-model',
-        epochs: 20,
-        roundDuration: 10,
-        validationSplit: 0,
-        batchSize: 30,
-        preprocessFunctions: [],
-        modelCompileData: {
-            optimizer: 'rmsprop',
-            loss: 'binaryCrossentropy',
-            metrics: ['accuracy']
-        },
-        receivedMessagesThreshold: 1,
-        dataType: 'tabular',
-        inputColumns: [
-            'PassengerId',
-            'Age',
-            'SibSp',
-            'Parch',
-            'Fare',
-            'Pclass'
-        ],
-        outputColumns: [
-            'Survived'
-        ],
-        scheme: 'Federated'
-    }
-};
-function model() {
-    var model = tf.sequential();
-    model.add(tf.layers.dense({
-        inputShape: [6],
-        units: 124,
-        activation: 'relu',
-        kernelInitializer: 'leCunNormal'
-    }));
-    model.add(tf.layers.dense({ units: 64, activation: 'relu' }));
-    model.add(tf.layers.dense({ units: 32, activation: 'relu' }));
-    model.add(tf.layers.dense({ units: 1, activation: 'sigmoid' }));
-    return model;
-}
-exports.model = model;

package/dist/tfjs.d.ts

@@ -1,2 +0,0 @@
-import * as tf from '@tensorflow/tfjs';
-export { tf };

package/dist/tfjs.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tf = void 0;
-var tslib_1 = require("tslib");
-var tf = (0, tslib_1.__importStar)(require("@tensorflow/tfjs"));
-exports.tf = tf;

package/dist/training/disco.d.ts

@@ -1,14 +0,0 @@
-import { Memory } from '@/memory';
-import { Client, dataset, Logger, Task, TrainingInformant, TrainingSchemes } from '..';
-import { TrainerLog } from '../logging/trainer_logger';
-export declare class Disco {
-    readonly task: Task;
-    readonly logger: Logger;
-    readonly memory: Memory;
-    private readonly client;
-    private readonly trainer;
-    constructor(task: Task, logger: Logger, memory: Memory, scheme: TrainingSchemes, informant: TrainingInformant, client: Client);
-    startTraining(dataTuple: dataset.DataTuple): Promise<void>;
-    stopTraining(): Promise<void>;
-    getTrainerLog(): Promise<TrainerLog>;
-}

package/dist/training/disco.js

@@ -1,70 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Disco = void 0;
-var tslib_1 = require("tslib");
-var __1 = require("..");
-var trainer_builder_1 = require("./trainer/trainer_builder");
-// Handles the training loop, server communication & provides the user with feedback.
-var Disco = /** @class */ (function () {
-    // client need to be connected
-    function Disco(task, logger, memory, scheme, informant, client) {
-        this.task = task;
-        this.logger = logger;
-        this.memory = memory;
-        this.client = client;
-        if (client.task !== task) {
-            throw new Error('client not setup for given task');
-        }
-        if (informant.taskID !== task.taskID) {
-            throw new Error('informant not setup for given task');
-        }
-        var trainerBuilder = new trainer_builder_1.TrainerBuilder(this.memory, this.task, informant);
-        this.trainer = trainerBuilder.build(this.client, scheme !== __1.TrainingSchemes.LOCAL);
-    }
-    Disco.prototype.startTraining = function (dataTuple) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            var valDataset;
-            return (0, tslib_1.__generator)(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        this.logger.success('Thank you for your contribution. Data preprocessing has started');
-                        valDataset = dataTuple.validation !== undefined ? dataTuple.validation.dataset : dataTuple.train.dataset;
-                        return [4 /*yield*/, this.trainer];
-                    case 1: return [4 /*yield*/, (_a.sent()).trainModel(dataTuple.train.dataset, valDataset)];
-                    case 2:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    // Stops the training function
-    //
-    // do not disconnect given client
-    Disco.prototype.stopTraining = function () {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            return (0, tslib_1.__generator)(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.trainer];
-                    case 1: return [4 /*yield*/, (_a.sent()).stopTraining()];
-                    case 2:
-                        _a.sent();
-                        this.logger.success('Training was successfully interrupted.');
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    Disco.prototype.getTrainerLog = function () {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            return (0, tslib_1.__generator)(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.trainer];
-                    case 1: return [2 /*return*/, (_a.sent()).getTrainerLog()];
-                }
-            });
-        });
-    };
-    return Disco;
-}());
-exports.Disco = Disco;

package/dist/training/training_schemes.d.ts

@@ -1,5 +0,0 @@
-export declare enum TrainingSchemes {
-    LOCAL = "local",
-    DECENTRALIZED = "deai",
-    FEDERATED = "feai"
-}