@epfml/discojs 2.1.2-p20240507135008.0 → 2.1.2-p20240513140724.0

package/README.md

@@ -0,0 +1,24 @@
+# @epfml/discojs
+
+Decentralized & federated privacy-preserving ML training in TypeScript.
+
+This is the core library of the Disco.js project.
+
+It is platform-agnostic, and has two companions library:
+ - [`discojs-node`](../discojs-node) for Node.js
+ - [`discojs-web`](../discojs-web) for web browsers
+
+The easiest way to start using it is through the `Disco` object.
+Create your own `Task` or load one from our `default_tasks`,
+setup the `Dataset` you want, and train with it.
+
+```ts
+import { Disco } from '@epfml/discojs'
+
+const url = ...; // url to a Disco.js server
+const dataset = ...;
+const task = ...;
+
+const disco = new Disco(task, { url })
+for await (const _ of disco.fit(dataset));
+```

package/dist/dataset/dataset_builder.js

@@ -92,7 +92,7 @@ export class DatasetBuilder {
     async build(config) {
         // Require that at least one source collection is non-empty, but not both
         if ((this._sources.length > 0) === (this.labelledSources.size > 0)) {
-            throw new Error('Please provide dataset input files');
+            throw new Error('Please provide dataset input files'); // This error message is parsed in DatasetInput.vue
         }
         let dataTuple;
         if (this._sources.length > 0) {

package/dist/default_tasks/cifar10/index.js

@@ -11,11 +11,10 @@ export const cifar10 = {
                     preview: 'In this challenge, we ask you to classify images into categories based on the objects shown on the image.',
                     overview: 'The CIFAR-10 dataset is a collection of images that are commonly used to train machine learning and computer vision algorithms. It is one of the most widely used datasets for machine learning research.'
                 },
-                limitations: 'The training data is limited to small images of size 32x32.',
-                tradeoffs: 'Training success strongly depends on label distribution',
                 dataFormatInformation: 'Images should be of .png format and of size 32x32. <br> The label file should be .csv, where each row contains a file_name, class.  <br> <br> e.g. if you have images: 0.png (of a frog) and 1.png (of a car) <br> labels.csv contains: (Note that no header is needed)<br> 0.png, frog <br> 1.png, car',
                 dataExampleText: 'Below you can find 10 random examples from each of the 10 classes in the dataset.',
-                dataExampleImage: 'https://storage.googleapis.com/deai-313515.appspot.com/example_training_data/cifar10-example.png'
+                dataExampleImage: 'https://storage.googleapis.com/deai-313515.appspot.com/example_training_data/cifar10-example.png',
+                sampleDatasetLink: 'https://www.kaggle.com/competitions/cifar-10/data'
             },
             trainingInformation: {
                 modelID: 'cifar10-model',
@@ -27,7 +26,7 @@ export const cifar10 = {
                 preprocessingFunctions: [data.ImagePreprocessing.Resize],
                 IMAGE_H: 224,
                 IMAGE_W: 224,
-                LABEL_LIST: ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9'],
+                LABEL_LIST: ['airplane', 'automobile', 'bird', 'cat', 'deer', 'dog', 'frog', 'horse', 'ship', 'truck'],
                 scheme: 'decentralized',
                 noiseScale: undefined,
                 clippingRadius: 20,

package/dist/default_tasks/index.d.ts

@@ -1,8 +1,6 @@
 export { cifar10 } from './cifar10/index.js';
-export { geotags } from './geotags/index.js';
 export { lusCovid } from './lus_covid.js';
 export { mnist } from './mnist.js';
 export { simpleFace } from './simple_face/index.js';
-export { skinMnist } from './skin_mnist.js';
 export { titanic } from './titanic.js';
 export { wikitext } from './wikitext.js';

package/dist/default_tasks/index.js

@@ -1,8 +1,6 @@
 export { cifar10 } from './cifar10/index.js';
-export { geotags } from './geotags/index.js';
 export { lusCovid } from './lus_covid.js';
 export { mnist } from './mnist.js';
 export { simpleFace } from './simple_face/index.js';
-export { skinMnist } from './skin_mnist.js';
 export { titanic } from './titanic.js';
 export { wikitext } from './wikitext.js';

package/dist/default_tasks/lus_covid.js

@@ -11,16 +11,16 @@ export const lusCovid = {
                     overview: "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' target='_blank'>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',
-                dataExampleImage: 'https://storage.googleapis.com/deai-313515.appspot.com/example_training_data/2_QAID_1.masked.reshaped.squared.224.png'
+                dataExampleImage: 'https://storage.googleapis.com/deai-313515.appspot.com/example_training_data/2_QAID_1.masked.reshaped.squared.224.png',
+                sampleDatasetLink: 'https://drive.switch.ch/index.php/s/zM5ZrUWK3taaIly'
             },
             trainingInformation: {
                 modelID: 'lus-covid-model',
                 epochs: 50,
                 roundDuration: 2,
-                validationSplit: 0,
+                validationSplit: 0.2,
                 batchSize: 5,
                 IMAGE_H: 100,
                 IMAGE_W: 100,

package/dist/default_tasks/mnist.js

@@ -11,7 +11,6 @@ export const mnist = {
                     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: 'http://storage.googleapis.com/deai-313515.appspot.com/example_training_data/9-mnist-example.png'

package/dist/default_tasks/simple_face/index.js

@@ -11,8 +11,6 @@ export const simpleFace = {
                     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: 'https://storage.googleapis.com/deai-313515.appspot.com/example_training_data/simple_face-example.png'

package/dist/default_tasks/titanic.js

@@ -11,7 +11,6 @@ export const titanic = {
                     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: [

package/dist/default_tasks/wikitext.js

@@ -9,10 +9,9 @@ export const wikitext = {
                     preview: 'In this challenge, we ask you to do next word prediction on a dataset of Wikipedia articles.',
                     overview: 'Wikitext-103-raw is a dataset comprising unprocessed text excerpts from Wikipedia articles, designed for tasks related to natural language processing and language modeling.'
                 },
-                limitations: 'The dataset may contain noise, inconsistencies, and unstructured content due to its raw nature, potentially posing challenges for certain NLP tasks.',
-                tradeoffs: 'The raw format may lack structured annotations and may require additional preprocessing for specific applications.',
                 dataFormatInformation: 'The dataset is organized as a large text file, with each line representing a segment of raw text from Wikipedia articles.',
-                dataExampleText: 'An example excerpt from the dataset could be: "The history of artificial intelligence dates back to ancient times, with philosophical discussions on the nature of thought and reasoning."'
+                dataExampleText: 'An example excerpt from the dataset could be: "The history of artificial intelligence dates back to ancient times, with philosophical discussions on the nature of thought and reasoning."',
+                sampleDatasetLink: 'https://dax-cdn.cdn.appdomain.cloud/dax-wikitext-103/1.0.1/wikitext-103.tar.gz'
             },
             trainingInformation: {
                 dataType: 'text',

package/dist/task/display_information.d.ts

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

package/dist/task/display_information.js

@@ -1,24 +1,37 @@
 import { isSummary } from './summary.js';
 import { isDataExample } from './data_example.js';
-import { isLabelType } from './label_type.js';
 export function isDisplayInformation(raw) {
     if (typeof raw !== 'object' || raw === null) {
         return false;
     }
-    const { dataExample, dataExampleImage, dataExampleText, dataFormatInformation, headers, labelDisplay, limitations, model, summary, taskTitle, tradeoffs } = raw;
+    const { dataExample, dataExampleImage, dataExampleText, dataFormatInformation, sampleDatasetLink, headers, model, summary, taskTitle, } = raw;
     if (typeof taskTitle !== 'string' ||
         (dataExampleText !== undefined && typeof dataExampleText !== 'string') ||
+        (sampleDatasetLink !== undefined && typeof sampleDatasetLink !== 'string') ||
         (dataFormatInformation !== undefined && typeof dataFormatInformation !== 'string') ||
-        (tradeoffs !== undefined && typeof tradeoffs !== 'string') ||
         (model !== undefined && typeof model !== 'string') ||
-        (dataExampleImage !== undefined && typeof dataExampleImage !== 'string') ||
-        (labelDisplay !== undefined && !isLabelType(labelDisplay)) ||
-        (limitations !== undefined && typeof limitations !== 'string')) {
+        (dataExampleImage !== undefined && typeof dataExampleImage !== 'string')) {
         return false;
     }
-    if (summary !== undefined && !isSummary(summary)) {
+    if (!isSummary(summary)) {
         return false;
     }
+    if (sampleDatasetLink !== undefined) {
+        try {
+            new URL(sampleDatasetLink);
+        }
+        catch {
+            return false;
+        }
+    }
+    if (dataExampleImage !== undefined) {
+        try {
+            new URL(dataExampleImage);
+        }
+        catch {
+            return false;
+        }
+    }
     if (dataExample !== undefined && !(Array.isArray(dataExample) &&
         dataExample.every(isDataExample))) {
         return false;
@@ -32,13 +45,11 @@ export function isDisplayInformation(raw) {
         dataExampleImage,
         dataExampleText,
         dataFormatInformation,
+        sampleDatasetLink,
         headers,
-        labelDisplay,
-        limitations,
         model,
         summary,
         taskTitle,
-        tradeoffs,
     };
     const _correct = repack;
     const _total = repack;

package/dist/task/index.d.ts

@@ -4,4 +4,3 @@ export { isDigest, type Digest } from './digest.js';
 export { isDisplayInformation, type DisplayInformation } from './display_information.js';
 export type { TrainingInformation } from './training_information.js';
 export { pushTask, fetchTasks } from './task_handler.js';
-export { LabelTypeEnum } from './label_type.js';

package/dist/task/index.js

@@ -2,4 +2,3 @@ export { isTask, isTaskID } from './task.js';
 export { isDigest } from './digest.js';
 export { isDisplayInformation } from './display_information.js';
 export { pushTask, fetchTasks } from './task_handler.js';
-export { LabelTypeEnum } from './label_type.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epfml/discojs",
-  "version": "2.1.2-p20240507135008.0",
+  "version": "2.1.2-p20240513140724.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/default_tasks/geotags/index.d.ts

@@ -1,2 +0,0 @@
-import type { TaskProvider } from '../../index.js';
-export declare const geotags: TaskProvider;

package/dist/default_tasks/geotags/index.js

@@ -1,65 +0,0 @@
-import { Range } from 'immutable';
-import * as tf from '@tensorflow/tfjs';
-import { data, models } from '../../index.js';
-import { LabelTypeEnum } from '../../task/label_type.js';
-import baseModel from './model.js';
-export const geotags = {
-    getTask() {
-        return {
-            id: 'geotags',
-            displayInformation: {
-                taskTitle: 'GeoTags',
-                summary: {
-                    preview: 'In this challenge, we predict the geo-location of a photo given its pixels in terms of a cell number of a grid built on top of Switzerland',
-                    overview: 'The geotags dataset is a collection of images with geo-location information used to train a machine learning algorithm to predict the location of a photo given its pixels.'
-                },
-                limitations: 'The training data is limited to images of size 224x224.',
-                tradeoffs: 'Training success strongly depends on label distribution',
-                dataFormatInformation: 'Images should be of .png format and of size 224x224. <br> The label file should be .csv, where each row contains a file_name, class.  The class is the cell number of a the given grid of Switzerland. ',
-                labelDisplay: {
-                    labelType: LabelTypeEnum.POLYGON_MAP,
-                    mapBaseUrl: 'https://disco-polygon.web.app/'
-                }
-            },
-            trainingInformation: {
-                modelID: 'geotags-model',
-                epochs: 10,
-                roundDuration: 10,
-                validationSplit: 0.2,
-                batchSize: 10,
-                dataType: 'image',
-                IMAGE_H: 224,
-                IMAGE_W: 224,
-                preprocessingFunctions: [data.ImagePreprocessing.Resize],
-                LABEL_LIST: Range(0, 127).map(String).toArray(),
-                scheme: 'federated',
-                noiseScale: undefined,
-                clippingRadius: 20,
-                decentralizedSecure: true,
-                minimumReadyPeers: 3,
-                maxShareValue: 100
-            }
-        };
-    },
-    async getModel() {
-        const pretrainedModel = await tf.loadLayersModel({
-            load: async () => Promise.resolve(baseModel),
-        });
-        const numLayers = pretrainedModel.layers.length;
-        pretrainedModel.layers.forEach(layer => { layer.trainable = false; });
-        pretrainedModel.layers[numLayers - 1].trainable = true;
-        const model = tf.sequential({
-            layers: [
-                tf.layers.inputLayer({ inputShape: [224, 224, 3] }),
-                tf.layers.rescaling({ scale: 1 / 127.5, offset: -1 }), // Rescaling input between -1 and 1
-                pretrainedModel
-            ]
-        });
-        model.compile({
-            optimizer: 'adam',
-            loss: 'categoricalCrossentropy',
-            metrics: ['accuracy']
-        });
-        return new models.TFJS(model);
-    }
-};