@epfml/discojs 3.0.1-p20241007204240.0 → 3.0.1-p20241024094708.0

package/dist/task/task_handler.js

@@ -1,22 +1,28 @@
-import axios from 'axios';
 import createDebug from "debug";
-import { Map } from 'immutable';
-import { serialization } from '../index.js';
-import { isTask } from './task.js';
+import { Map } from "immutable";
+import { serialization } from "../index.js";
+import { isTask } from "./task.js";
 const debug = createDebug("discojs:task:handlers");
-const TASK_ENDPOINT = 'tasks';
-export async function pushTask(url, task, model) {
-    await axios.post(url.href + TASK_ENDPOINT, {
-        task,
-        model: await serialization.model.encode(model),
-        weights: await serialization.weights.encode(model.weights)
+function urlToTasks(base) {
+    const ret = new URL(base);
+    ret.pathname += "tasks";
+    return ret;
+}
+export async function pushTask(base, task, model) {
+    await fetch(urlToTasks(base), {
+        method: "POST",
+        body: JSON.stringify({
+            task,
+            model: await serialization.model.encode(model),
+            weights: await serialization.weights.encode(model.weights),
+        }),
     });
 }
-export async function fetchTasks(url) {
-    const response = await axios.get(new URL(TASK_ENDPOINT, url).href);
-    const tasks = response.data;
+export async function fetchTasks(base) {
+    const response = await fetch(urlToTasks(base));
+    const tasks = await response.json();
     if (!Array.isArray(tasks)) {
-        throw new Error('Expected to receive an array of Tasks when fetching tasks');
+        throw new Error("Expected to receive an array of Tasks when fetching tasks");
     }
     else if (!tasks.every(isTask)) {
         for (const task of tasks) {
@@ -24,7 +30,7 @@ export async function fetchTasks(url) {
                 debug("task has invalid format: :O", task);
             }
         }
-        throw new Error('invalid tasks response, the task object received is not well formatted');
+        throw new Error("invalid tasks response, the task object received is not well formatted");
     }
     return Map(tasks.map((t) => [t.id, t]));
 }

package/dist/task/training_information.d.ts

@@ -18,10 +18,9 @@ export interface TrainingInformation {
     LABEL_LIST?: string[];
     scheme: 'decentralized' | 'federated' | 'local';
     privacy?: Privacy;
-    decentralizedSecure?: boolean;
     maxShareValue?: number;
     minNbOfParticipants: number;
-    aggregator?: 'mean' | 'secure';
+    aggregationStrategy?: 'mean' | 'secure';
     tokenizer?: string | PreTrainedTokenizer;
     maxSequenceLength?: number;
     tensorBackend: 'tfjs' | 'gpt';

package/dist/task/training_information.js

@@ -24,7 +24,7 @@ export function isTrainingInformation(raw) {
     if (typeof raw !== 'object' || raw === null) {
         return false;
     }
-    const { IMAGE_H, IMAGE_W, LABEL_LIST, aggregator, batchSize, dataType, decentralizedSecure, privacy, epochs, inputColumns, maxShareValue, minNbOfParticipants, outputColumns, preprocessingFunctions, roundDuration, scheme, validationSplit, tokenizer, maxSequenceLength, tensorBackend } = raw;
+    const { IMAGE_H, IMAGE_W, LABEL_LIST, aggregationStrategy, batchSize, dataType, privacy, epochs, inputColumns, maxShareValue, minNbOfParticipants, outputColumns, preprocessingFunctions, roundDuration, scheme, validationSplit, tokenizer, maxSequenceLength, tensorBackend } = raw;
     if (typeof dataType !== 'string' ||
         typeof epochs !== 'number' ||
         typeof batchSize !== 'number' ||
@@ -33,8 +33,7 @@ export function isTrainingInformation(raw) {
         typeof minNbOfParticipants !== 'number' ||
         (tokenizer !== undefined && typeof tokenizer !== 'string' && !(tokenizer instanceof PreTrainedTokenizer)) ||
         (maxSequenceLength !== undefined && typeof maxSequenceLength !== 'number') ||
-        (aggregator !== undefined && typeof aggregator !== 'string') ||
-        (decentralizedSecure !== undefined && typeof decentralizedSecure !== 'boolean') ||
+        (aggregationStrategy !== undefined && typeof aggregationStrategy !== 'string') ||
         (privacy !== undefined && !isPrivacy(privacy)) ||
         (maxShareValue !== undefined && typeof maxShareValue !== 'number') ||
         (IMAGE_H !== undefined && typeof IMAGE_H !== 'number') ||
@@ -45,8 +44,8 @@ export function isTrainingInformation(raw) {
         (preprocessingFunctions !== undefined && !Array.isArray(preprocessingFunctions))) {
         return false;
     }
-    if (aggregator !== undefined) {
-        switch (aggregator) {
+    if (aggregationStrategy !== undefined) {
+        switch (aggregationStrategy) {
             case 'mean': break;
             case 'secure': break;
             default: return false;
@@ -58,7 +57,7 @@ export function isTrainingInformation(raw) {
         case 'text': break;
         default: return false;
     }
-    // interdepences on data type
+    // interdependencies on data type
     if (dataType === 'image') {
         if (typeof IMAGE_H !== 'number' || typeof IMAGE_W !== 'number') {
             return false;
@@ -87,10 +86,9 @@ export function isTrainingInformation(raw) {
         IMAGE_W,
         IMAGE_H,
         LABEL_LIST,
-        aggregator,
+        aggregationStrategy,
         batchSize,
         dataType,
-        decentralizedSecure,
         privacy,
         epochs,
         inputColumns,

package/dist/training/disco.d.ts

@@ -7,7 +7,10 @@ interface DiscoConfig {
     scheme: TrainingInformation["scheme"];
     logger: Logger;
 }
-export type RoundStatus = "Waiting for more participants" | "Retrieving peers' information" | "Updating the model with other participants' models" | "Training the model on the data you connected";
+export type RoundStatus = 'not enough participants' | // Server notification to wait for more participants
+'updating model' | // fetching/aggregating local updates into a global model
+'local training' | // Training the model locally
+'connecting to peers';
 /**
  * Top-level class handling distributed training from a client's perspective. It is meant to be
  * a convenient object providing a reduced yet complete API that wraps model training and

package/dist/training/trainer.js

@@ -62,7 +62,7 @@ export class Trainer {
         }
         return {
             epochs: epochsLogs,
-            participants: this.#client.nbOfParticipants,
+            participants: this.#client.getNbOfParticipants(),
         };
     }
 }

package/dist/utils/event_emitter.d.ts

@@ -1,11 +1,11 @@
-type Listener<T> = (_: T) => void;
+type Listener<T> = (_: T) => void | Promise<void>;
 /**
  * Call handlers on given events
  *
  * @typeParam I object/mapping from event name to emitted value type
  */
 export declare class EventEmitter<I extends Record<string, unknown>> {
-    private listeners;
+    #private;
     /**
      * @param initialListeners object/mapping of event name to listener, as if using `on` on created instance
      */
@@ -13,7 +13,7 @@ export declare class EventEmitter<I extends Record<string, unknown>> {
         [E in keyof I]?: Listener<I[E]>;
     });
     /**
-     * Register listener to call on event
+     * Register listener to call on event.
      *
      * @param event event name to listen to
      * @param listener handler to call

package/dist/utils/event_emitter.js

@@ -6,7 +6,8 @@ import { List } from 'immutable';
  * @typeParam I object/mapping from event name to emitted value type
  */
 export class EventEmitter {
-    listeners = {};
+    // List of callbacks to run per event
+    #listeners = {};
     /**
      * @param initialListeners object/mapping of event name to listener, as if using `on` on created instance
      */
@@ -19,14 +20,14 @@ export class EventEmitter {
         }
     }
     /**
-     * Register listener to call on event
+     * Register listener to call on event.
      *
      * @param event event name to listen to
      * @param listener handler to call
      */
     on(event, listener) {
-        const eventListeners = this.listeners[event] ?? List();
-        this.listeners[event] = eventListeners.push([false, listener]);
+        const eventListeners = this.#listeners[event] ?? List();
+        this.#listeners[event] = eventListeners.push([false, listener]);
     }
     /**
      * Register listener to call once on next event
@@ -35,8 +36,8 @@ export class EventEmitter {
      * @param listener handler to call next time
      */
     once(event, listener) {
-        const eventListeners = this.listeners[event] ?? List();
-        this.listeners[event] = eventListeners.push([true, listener]);
+        const eventListeners = this.#listeners[event] ?? List();
+        this.#listeners[event] = eventListeners.push([true, listener]);
     }
     /**
      * Send value to registered listeners of event name
@@ -45,9 +46,9 @@ export class EventEmitter {
      * @param value what to call listeners with
      */
     emit(event, value) {
-        const eventListeners = this.listeners[event] ?? List();
-        this.listeners[event] = eventListeners.filterNot(([once]) => once);
-        eventListeners.forEach(([_, listener]) => { listener(value); });
+        const eventListeners = this.#listeners[event] ?? List();
+        this.#listeners[event] = eventListeners.filterNot(([once]) => once);
+        eventListeners.forEach(async ([_, listener]) => { await listener(value); });
     }
 }
 /** `EventEmitter` for all events */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epfml/discojs",
-  "version": "3.0.1-p20241007204240.0",
+  "version": "3.0.1-p20241024094708.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,13 +19,12 @@
   },
   "homepage": "https://github.com/epfml/disco#readme",
   "dependencies": {
+    "@msgpack/msgpack": "^3.0.0-beta2",
     "@tensorflow/tfjs": "4",
     "@xenova/transformers": "2",
-    "axios": "1",
     "immutable": "4",
     "isomorphic-wrtc": "1",
     "isomorphic-ws": "5",
-    "msgpack-lite": "0.1",
     "simple-peer": "9",
     "tslib": "2",
     "ws": "8"