@epfml/discojs 3.0.1-p20250331133703.0 → 3.0.1-p20250402090722.0

package/dist/client/client.d.ts

@@ -9,7 +9,9 @@ import { EventEmitter } from '../utils/event_emitter.js';
  */
 export declare abstract class Client extends EventEmitter<{
     'status': RoundStatus;
+    'participants': number;
 }> {
+    #private;
     readonly url: URL;
     readonly task: Task<DataType>;
     readonly aggregator: Aggregator;
@@ -22,13 +24,6 @@ export declare abstract class Client extends EventEmitter<{
      * until the server signals that the training can resume
      */
     protected promiseForMoreParticipants: Promise<void> | undefined;
-    /**
-     * When the server notifies the client that they can resume training
-     * after waiting for more participants, we want to be able to display what
-     * we were doing before waiting (training locally or updating our model).
-     * We use this attribute to store the status to rollback to when we stop waiting
-     */
-    private previousStatus;
     constructor(url: URL, // The network server's URL to connect to
     task: Task<DataType>, // The client's corresponding task
     aggregator: Aggregator);
@@ -101,7 +96,12 @@ export declare abstract class Client extends EventEmitter<{
     * If federated, it should the number of participants excluding the server
     * If local it should be 1
     */
-    abstract getNbOfParticipants(): number;
+    get nbOfParticipants(): number;
+    /**
+     * Setter for the number of participants
+     * It emits the number of participants to the client
+     */
+    set nbOfParticipants(nbOfParticipants: number);
     get ownId(): NodeID;
     get server(): EventConnection;
     /**

package/dist/client/client.js

@@ -29,7 +29,9 @@ export class Client extends EventEmitter {
      * we were doing before waiting (training locally or updating our model).
      * We use this attribute to store the status to rollback to when we stop waiting
      */
-    previousStatus;
+    #previousStatus;
+    // Current number of participants including this client in the training session
+    #nbOfParticipants = 1;
     constructor(url, // The network server's URL to connect to
     task, // The client's corresponding task
     aggregator) {
@@ -56,7 +58,7 @@ export class Client extends EventEmitter {
      * the waiting status and once enough participants join, it can display the previous status again
      */
     saveAndEmit(status) {
-        this.previousStatus = status;
+        this.#previousStatus = status;
         this.emit("status", status);
     }
     /**
@@ -84,12 +86,13 @@ export class Client extends EventEmitter {
     setupServerCallbacks(setMessageInversionFlag) {
         // Setup an event callback if the server signals that we should 
         // wait for more participants
-        this.server.on(type.WaitingForMoreParticipants, () => {
+        this.server.on(type.WaitingForMoreParticipants, (event) => {
             if (this.promiseForMoreParticipants !== undefined)
                 throw new Error("Server sent multiple WaitingForMoreParticipants messages");
             debug(`[${shortenId(this.ownId)}] received WaitingForMoreParticipants message from server`);
             // Display the waiting status right away
             this.emit("status", "not enough participants");
+            this.nbOfParticipants = event.nbOfParticipants; // emits the `participants` event
             // Upon receiving a WaitingForMoreParticipants message,
             // the client will await for this promise to resolve before sending its
             // local weight update
@@ -101,10 +104,10 @@ export class Client extends EventEmitter {
         // and directly follows with an EnoughParticipants message when the 2nd participant joins
         // However, the EnoughParticipants can arrive before the NewNodeInfo (which can be much bigger)
         // so we check whether we received the EnoughParticipants before being assigned a node ID
-        this.server.once(type.EnoughParticipants, () => {
+        this.server.once(type.EnoughParticipants, (event) => {
             if (this._ownId === undefined) {
-                debug(`Received EnoughParticipants message from server before the NewFederatedNodeInfo message`);
                 setMessageInversionFlag();
+                this.nbOfParticipants = event.nbOfParticipants;
             }
         });
     }
@@ -118,11 +121,12 @@ export class Client extends EventEmitter {
     async createPromiseForMoreParticipants() {
         return new Promise((resolve) => {
             // "once" is important because we can't resolve the same promise multiple times
-            this.server.once(type.EnoughParticipants, () => {
+            this.server.once(type.EnoughParticipants, (event) => {
                 debug(`[${shortenId(this.ownId)}] received EnoughParticipants message from server`);
                 // Emit the last status emitted before waiting if defined
-                if (this.previousStatus !== undefined)
-                    this.emit("status", this.previousStatus);
+                if (this.#previousStatus !== undefined)
+                    this.emit("status", this.#previousStatus);
+                this.nbOfParticipants = event.nbOfParticipants;
                 resolve();
             });
         });
@@ -154,6 +158,23 @@ export class Client extends EventEmitter {
         const encoded = new Uint8Array(await response.arrayBuffer());
         return await serialization.model.decode(encoded);
     }
+    /**
+    * Number of contributors to a collaborative session
+    * If decentralized, it should be the number of peers
+    * If federated, it should the number of participants excluding the server
+    * If local it should be 1
+    */
+    get nbOfParticipants() {
+        return this.#nbOfParticipants;
+    }
+    /**
+     * Setter for the number of participants
+     * It emits the number of participants to the client
+     */
+    set nbOfParticipants(nbOfParticipants) {
+        this.#nbOfParticipants = nbOfParticipants;
+        this.emit("participants", nbOfParticipants);
+    }
     get ownId() {
         if (this._ownId === undefined) {
             throw new Error('the node is not connected');

package/dist/client/decentralized/decentralized_client.d.ts

@@ -8,8 +8,8 @@ import { Client } from '../client.js';
  */
 export declare class DecentralizedClient extends Client {
     #private;
-    getNbOfParticipants(): number;
     private get isDisconnected();
+    private setAggregatorNodes;
     /**
      * Public method called by disco.ts when starting training. This method sends
      * a message to the server asking to join the task and be assigned a client ID.

package/dist/client/decentralized/decentralized_client.js

@@ -20,14 +20,15 @@ export class DecentralizedClient extends Client {
      */
     #pool;
     #connections;
-    getNbOfParticipants() {
-        const nbOfParticipants = this.aggregator.nodes.size;
-        return nbOfParticipants === 0 ? 1 : nbOfParticipants;
-    }
     // Used to handle timeouts and promise resolving after calling disconnect
     get isDisconnected() {
         return this._server === undefined;
     }
+    setAggregatorNodes(nodes) {
+        this.aggregator.setNodes(nodes);
+        // Emits the `participants` event
+        this.nbOfParticipants = this.aggregator.nodes.size === 0 ? 1 : this.aggregator.nodes.size;
+    }
     /**
      * Public method called by disco.ts when starting training. This method sends
      * a message to the server asking to join the task and be assigned a client ID.
@@ -67,7 +68,8 @@ export class DecentralizedClient extends Client {
             type: type.ClientConnected
         };
         this.server.send(msg);
-        const { id, waitForMoreParticipants } = await waitMessage(this.server, type.NewDecentralizedNodeInfo);
+        const { id, waitForMoreParticipants, nbOfParticipants } = await waitMessage(this.server, type.NewDecentralizedNodeInfo);
+        this.nbOfParticipants = nbOfParticipants;
         // This should come right after receiving the message to make sure
         // we don't miss a subsequent message from the server
         // We check if the server is telling us to wait for more participants
@@ -92,7 +94,7 @@ export class DecentralizedClient extends Client {
         this.#pool = undefined;
         if (this.#connections !== undefined) {
             const peers = this.#connections.keySeq().toSet();
-            this.aggregator.setNodes(this.aggregator.nodes.subtract(peers));
+            this.setAggregatorNodes(this.aggregator.nodes.subtract(peers));
         }
         // Disconnect from server
         await this.server?.disconnect();
@@ -158,7 +160,7 @@ export class DecentralizedClient extends Client {
                 throw new Error('received peer list contains our own id');
             }
             // Store the list of peers for the current round including ourselves
-            this.aggregator.setNodes(peers.add(this.ownId));
+            this.setAggregatorNodes(peers.add(this.ownId));
             this.aggregator.setRound(receivedMessage.aggregationRound); // the server gives us the round number
             // Initiate peer to peer connections with each peer
             // When connected, create a promise waiting for each peer's round contribution
@@ -171,7 +173,7 @@ export class DecentralizedClient extends Client {
         }
         catch (e) {
             debug(`Error for [${shortenId(this.ownId)}] while beginning round: %o`, e);
-            this.aggregator.setNodes(Set(this.ownId));
+            this.setAggregatorNodes(Set(this.ownId));
             this.#connections = Map();
         }
     }

package/dist/client/decentralized/messages.d.ts

@@ -7,6 +7,7 @@ export interface NewDecentralizedNodeInfo {
     type: type.NewDecentralizedNodeInfo;
     id: NodeID;
     waitForMoreParticipants: boolean;
+    nbOfParticipants: number;
 }
 export interface SignalForPeer {
     type: type.SignalForPeer;

package/dist/client/federated/federated_client.d.ts

@@ -5,8 +5,6 @@ import { Client } from "../client.js";
  * a specific task in the federated setting.
  */
 export declare class FederatedClient extends Client {
-    #private;
-    getNbOfParticipants(): number;
     /**
      * Initializes the connection to the server, gets our node ID
      * as well as the latest training information: latest global model, current round and

package/dist/client/federated/federated_client.js

@@ -16,13 +16,6 @@ const SERVER_NODE_ID = "federated-server-node-id";
  * a specific task in the federated setting.
  */
 export class FederatedClient extends Client {
-    // Total number of other federated contributors, including this client, excluding the server
-    // E.g., if 3 users are training a federated model, nbOfParticipants is 3
-    #nbOfParticipants = 1;
-    // the number of participants excluding the server
-    getNbOfParticipants() {
-        return this.#nbOfParticipants;
-    }
     /**
      * Initializes the connection to the server, gets our node ID
      * as well as the latest training information: latest global model, current round and
@@ -70,7 +63,7 @@ export class FederatedClient extends Client {
         this._ownId = id;
         debug(`[${shortenId(id)}] joined session at round ${round} `);
         this.aggregator.setRound(round);
-        this.#nbOfParticipants = nbOfParticipants;
+        this.nbOfParticipants = nbOfParticipants;
         // Upon connecting, the server answers with a boolean
         // which indicates whether there are enough participants or not
         debug(`[${shortenId(this.ownId)}] upon connecting, wait for participant flag %o`, this.waitingForMoreParticipants);
@@ -129,7 +122,7 @@ export class FederatedClient extends Client {
         this.server.send(msg);
         debug(`[${shortenId(this.ownId)}] is waiting for server update for round ${this.aggregator.round + 1}`);
         const { payload: payloadFromServer, round: serverRound, nbOfParticipants } = await waitMessage(this.server, type.ReceiveServerPayload); // Wait indefinitely for the server update
-        this.#nbOfParticipants = nbOfParticipants; // Save the current participants
+        this.nbOfParticipants = nbOfParticipants; // Save the current participants
         const serverResult = serialization.weights.decode(payloadFromServer);
         this.aggregator.setRound(serverRound);
         return serverResult;

package/dist/client/local_client.d.ts

@@ -5,7 +5,6 @@ import { Client } from "./client.js";
  * with anyone. Thus LocalClient doesn't do anything during communication
  */
 export declare class LocalClient extends Client {
-    getNbOfParticipants(): number;
     onRoundBeginCommunication(): Promise<void>;
     onRoundEndCommunication(weights: WeightsContainer): Promise<WeightsContainer>;
 }

package/dist/client/local_client.js

@@ -4,9 +4,6 @@ import { Client } from "./client.js";
  * with anyone. Thus LocalClient doesn't do anything during communication
  */
 export class LocalClient extends Client {
-    getNbOfParticipants() {
-        return 1;
-    }
     onRoundBeginCommunication() {
         return Promise.resolve();
     }

package/dist/client/messages.d.ts

@@ -19,9 +19,11 @@ export interface ClientConnected {
 }
 export interface EnoughParticipants {
     type: type.EnoughParticipants;
+    nbOfParticipants: number;
 }
 export interface WaitingForMoreParticipants {
     type: type.WaitingForMoreParticipants;
+    nbOfParticipants: number;
 }
 export type Message = decentralized.MessageFromServer | decentralized.MessageToServer | decentralized.PeerMessage | federated.MessageFederated;
 export type NarrowMessage<D> = Extract<Message, {

package/dist/training/disco.d.ts

@@ -26,6 +26,7 @@ export type RoundStatus = 'not enough participants' | // Server notification to
  */
 export declare class Disco<D extends DataType> extends EventEmitter<{
     status: RoundStatus;
+    participants: number;
 }> {
     #private;
     readonly trainer: Trainer<D>;

package/dist/training/disco.js

@@ -53,6 +53,7 @@ export class Disco extends EventEmitter {
         this.trainer = new Trainer(task, client);
         // Simply propagate the training status events emitted by the client
         this.#client.on("status", (status) => this.emit("status", status));
+        this.#client.on("participants", (nbParticipants) => this.emit("participants", nbParticipants));
     }
     /** Train on dataset, yielding logs of every round. */
     async *trainByRound(dataset) {

package/dist/training/trainer.js

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

package/package.json

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