@epfml/discojs 2.0.0 → 2.1.2-p20240506085037.0

package/dist/core/tasks/simple_face.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.task = void 0;
-var __1 = require("..");
-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: 'https://storage.googleapis.com/deai-313515.appspot.com/example_training_data/simple_face-example.png'
-    },
-    trainingInformation: {
-        modelID: 'simple_face-model',
-        epochs: 50,
-        modelURL: 'https://storage.googleapis.com/deai-313515.appspot.com/models/mobileNetV2_35_alpha_2_classes/model.json',
-        roundDuration: 1,
-        validationSplit: 0.2,
-        batchSize: 10,
-        preprocessingFunctions: [__1.data.ImagePreprocessing.Normalize],
-        learningRate: 0.001,
-        modelCompileData: {
-            optimizer: 'sgd',
-            loss: 'categoricalCrossentropy',
-            metrics: ['accuracy']
-        },
-        dataType: 'image',
-        IMAGE_H: 200,
-        IMAGE_W: 200,
-        LABEL_LIST: ['child', 'adult'],
-        scheme: 'Federated',
-        noiseScale: undefined,
-        clippingRadius: undefined
-    }
-};

package/dist/core/tasks/titanic.d.ts

@@ -1,3 +0,0 @@
-import { tf, Task } from '..';
-export declare const task: Task;
-export declare function model(): tf.LayersModel;

package/dist/core/tasks/titanic.js

@@ -1,88 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.model = exports.task = void 0;
-var __1 = require("..");
-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='https://github.com/epfml/disco/raw/develop/example_training_data/titanic_train.csv'>titanic_train.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,
-        preprocessingFunctions: [],
-        modelCompileData: {
-            optimizer: 'rmsprop',
-            loss: 'binaryCrossentropy',
-            metrics: ['accuracy']
-        },
-        dataType: 'tabular',
-        inputColumns: [
-            'PassengerId',
-            'Age',
-            'SibSp',
-            'Parch',
-            'Fare',
-            'Pclass'
-        ],
-        outputColumns: [
-            'Survived'
-        ],
-        scheme: 'Federated',
-        noiseScale: undefined,
-        clippingRadius: undefined
-    }
-};
-function model() {
-    var model = __1.tf.sequential();
-    model.add(__1.tf.layers.dense({
-        inputShape: [6],
-        units: 124,
-        activation: 'relu',
-        kernelInitializer: 'leCunNormal'
-    }));
-    model.add(__1.tf.layers.dense({ units: 64, activation: 'relu' }));
-    model.add(__1.tf.layers.dense({ units: 32, activation: 'relu' }));
-    model.add(__1.tf.layers.dense({ units: 1, activation: 'sigmoid' }));
-    return model;
-}
-exports.model = model;

package/dist/core/training/disco.d.ts

@@ -1,23 +0,0 @@
-import { Client, data, Logger, Task, TrainingInformant, TrainingSchemes, Memory } from '..';
-import { TrainerLog } from '../logging/trainer_logger';
-interface DiscoOptions {
-    client?: Client;
-    url?: string | URL;
-    scheme?: TrainingSchemes;
-    informant?: TrainingInformant;
-    logger?: Logger;
-    memory?: Memory;
-}
-export declare class Disco {
-    readonly task: Task;
-    readonly logger: Logger;
-    readonly memory: Memory;
-    private readonly client;
-    private readonly trainer;
-    constructor(task: Task, options: DiscoOptions);
-    fit(dataTuple: data.DataSplit): Promise<void>;
-    pause(): Promise<void>;
-    close(): Promise<void>;
-    logs(): Promise<TrainerLog>;
-}
-export {};

package/dist/core/training/disco.js

@@ -1,130 +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, options) {
-        if (options.scheme === undefined) {
-            options.scheme = __1.TrainingSchemes[task.trainingInformation.scheme];
-        }
-        if (options.client === undefined) {
-            if (options.url === undefined) {
-                throw new Error('could not determine client from given parameters');
-            }
-            if (typeof options.url === 'string') {
-                options.url = new URL(options.url);
-            }
-            switch (options.scheme) {
-                case __1.TrainingSchemes.FEDERATED:
-                    options.client = new __1.client.federated.Client(options.url, task);
-                    break;
-                case __1.TrainingSchemes.DECENTRALIZED:
-                    options.client = new __1.client.federated.Client(options.url, task);
-                    break;
-                default:
-                    options.client = new __1.client.Local(options.url, task);
-                    break;
-            }
-        }
-        if (options.informant === undefined) {
-            switch (options.scheme) {
-                case __1.TrainingSchemes.FEDERATED:
-                    options.informant = new __1.informant.FederatedInformant(task);
-                    break;
-                case __1.TrainingSchemes.DECENTRALIZED:
-                    options.informant = new __1.informant.DecentralizedInformant(task);
-                    break;
-                default:
-                    options.informant = new __1.informant.LocalInformant(task);
-                    break;
-            }
-        }
-        if (options.logger === undefined) {
-            options.logger = new __1.ConsoleLogger();
-        }
-        if (options.memory === undefined) {
-            options.memory = new __1.EmptyMemory();
-        }
-        if (options.client.task !== task) {
-            throw new Error('client not setup for given task');
-        }
-        if (options.informant.task.taskID !== task.taskID) {
-            throw new Error('informant not setup for given task');
-        }
-        this.task = task;
-        this.client = options.client;
-        this.memory = options.memory;
-        this.logger = options.logger;
-        var trainerBuilder = new trainer_builder_1.TrainerBuilder(this.memory, this.task, options.informant);
-        this.trainer = trainerBuilder.build(this.client, options.scheme !== __1.TrainingSchemes.LOCAL);
-    }
-    Disco.prototype.fit = function (dataTuple) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            var trainDataset, 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');
-                        trainDataset = dataTuple.train.batch().preprocess();
-                        valDataset = dataTuple.validation !== undefined
-                            ? dataTuple.validation.batch().preprocess()
-                            : trainDataset;
-                        return [4 /*yield*/, this.client.connect()];
-                    case 1:
-                        _a.sent();
-                        return [4 /*yield*/, this.trainer];
-                    case 2: return [4 /*yield*/, (_a.sent()).trainModel(trainDataset.dataset, valDataset.dataset)];
-                    case 3:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    // Stops the training function. Does not disconnect the client.
-    Disco.prototype.pause = 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.close = 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.pause()];
-                    case 1:
-                        _a.sent();
-                        return [4 /*yield*/, this.client.disconnect()];
-                    case 2:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    Disco.prototype.logs = 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/core/training/index.d.ts

@@ -1,2 +0,0 @@
-export { Disco } from './disco';
-export { TrainingSchemes } from './training_schemes';

package/dist/core/training/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TrainingSchemes = exports.Disco = void 0;
-var disco_1 = require("./disco");
-Object.defineProperty(exports, "Disco", { enumerable: true, get: function () { return disco_1.Disco; } });
-var training_schemes_1 = require("./training_schemes");
-Object.defineProperty(exports, "TrainingSchemes", { enumerable: true, get: function () { return training_schemes_1.TrainingSchemes; } });

package/dist/core/training/trainer/distributed_trainer.d.ts

@@ -1,20 +0,0 @@
-import { tf, Client, Memory, Task, TrainingInformant } from '../..';
-import { Trainer } from './trainer';
-/**
- * Class whose role is to train a model in a distributed way with a given dataset.
- */
-export declare class DistributedTrainer extends Trainer {
-    private readonly previousRoundModel;
-    private readonly client;
-    /** DistributedTrainer constructor, accepts same arguments as Trainer and in additional also a client who takes care of communicating weights.
-     */
-    constructor(task: Task, trainingInformant: TrainingInformant, memory: Memory, model: tf.LayersModel, previousRoundModel: tf.LayersModel, client: Client);
-    /**
-     * Callback called every time a round is over
-     */
-    onRoundEnd(accuracy: number): Promise<void>;
-    /**
-     * Callback called once training is over
-     */
-    onTrainEnd(): Promise<void>;
-}

package/dist/core/training/trainer/distributed_trainer.js

@@ -1,65 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DistributedTrainer = void 0;
-var tslib_1 = require("tslib");
-var __1 = require("../..");
-var trainer_1 = require("./trainer");
-/**
- * Class whose role is to train a model in a distributed way with a given dataset.
- */
-var DistributedTrainer = /** @class */ (function (_super) {
-    (0, tslib_1.__extends)(DistributedTrainer, _super);
-    /** DistributedTrainer constructor, accepts same arguments as Trainer and in additional also a client who takes care of communicating weights.
-     */
-    function DistributedTrainer(task, trainingInformant, memory, model, previousRoundModel, client) {
-        var _this = _super.call(this, task, trainingInformant, memory, model) || this;
-        _this.previousRoundModel = previousRoundModel;
-        _this.client = client;
-        return _this;
-    }
-    /**
-     * Callback called every time a round is over
-     */
-    DistributedTrainer.prototype.onRoundEnd = function (accuracy) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            var currentRoundWeights, previousRoundWeights, aggregatedWeights;
-            return (0, tslib_1.__generator)(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        currentRoundWeights = __1.WeightsContainer.from(this.model);
-                        previousRoundWeights = __1.WeightsContainer.from(this.previousRoundModel);
-                        return [4 /*yield*/, this.client.onRoundEndCommunication(currentRoundWeights, previousRoundWeights, this.roundTracker.round, this.trainingInformant)];
-                    case 1:
-                        aggregatedWeights = _a.sent();
-                        this.previousRoundModel.setWeights(currentRoundWeights.weights);
-                        this.model.setWeights(aggregatedWeights.weights);
-                        return [4 /*yield*/, this.memory.updateWorkingModel({ taskID: this.task.taskID, name: this.trainingInformation.modelID }, this.model)];
-                    case 2:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    // if it is undefined, will training continue? we hope yes
-    /**
-     * Callback called once training is over
-     */
-    DistributedTrainer.prototype.onTrainEnd = 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.client.onTrainEndCommunication(__1.WeightsContainer.from(this.model), this.trainingInformant)];
-                    case 1:
-                        _a.sent();
-                        return [4 /*yield*/, _super.prototype.onTrainEnd.call(this)];
-                    case 2:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    return DistributedTrainer;
-}(trainer_1.Trainer));
-exports.DistributedTrainer = DistributedTrainer;

package/dist/core/training/trainer/local_trainer.d.ts

@@ -1,11 +0,0 @@
-import { tf } from '../..';
-import { Trainer } from './trainer';
-/** Class whose role is to locally (alone) train a model on a given dataset, without any collaborators.
- */
-export declare class LocalTrainer extends Trainer {
-    /**
-     * Callback called every time a round is over. For local training, a round is typically an epoch
-     */
-    onRoundEnd(accuracy: number): Promise<void>;
-    protected onEpochEnd(epoch: number, logs?: tf.Logs): void;
-}

package/dist/core/training/trainer/local_trainer.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LocalTrainer = void 0;
-var tslib_1 = require("tslib");
-var trainer_1 = require("./trainer");
-/** Class whose role is to locally (alone) train a model on a given dataset, without any collaborators.
- */
-var LocalTrainer = /** @class */ (function (_super) {
-    (0, tslib_1.__extends)(LocalTrainer, _super);
-    function LocalTrainer() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    /**
-     * Callback called every time a round is over. For local training, a round is typically an epoch
-     */
-    LocalTrainer.prototype.onRoundEnd = function (accuracy) {
-        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.memory.updateWorkingModel({ taskID: this.task.taskID, name: this.trainingInformation.modelID }, this.model)];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    LocalTrainer.prototype.onEpochEnd = function (epoch, logs) {
-        _super.prototype.onEpochEnd.call(this, epoch, logs);
-        this.trainingInformant.update({ currentRound: epoch });
-    };
-    return LocalTrainer;
-}(trainer_1.Trainer));
-exports.LocalTrainer = LocalTrainer;

package/dist/core/training/trainer/round_tracker.d.ts

@@ -1,30 +0,0 @@
-/**
- * Class that keeps track of the current batch in order for the trainer to query when round has ended.
- *
- * @remark
- * In distributed training, the client trains locally for a certain amount of epochs before sharing his weights to the server/neighbor, this
- * is what we call a round.
- *
- * The role of the RoundTracker is to keep track of when a roundHasEnded using the current batch number. The batch in the RoundTracker is cumulative whereas
- * in the onBatchEnd it is not (it resets to 0 after each epoch).
- *
- * The roundDuration is the length of a round (in batches).
- */
-export declare class RoundTracker {
-    round: number;
-    batch: number;
-    roundDuration: number;
-    constructor(roundDuration: number);
-    /**
-     * Update the batch number, to be called inside onBatchEnd. (We do not use batch output of onBatchEnd since it is
-     * not cumulative).
-     */
-    updateBatch(): void;
-    /**
-     * Returns true if a local round has ended, false otherwise.
-     *
-     * @remark
-     * Returns true if (batch) mod (batches per round) == 0, false otherwise
-     */
-    roundHasEnded(): boolean;
-}

package/dist/core/training/trainer/round_tracker.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RoundTracker = void 0;
-/**
- * Class that keeps track of the current batch in order for the trainer to query when round has ended.
- *
- * @remark
- * In distributed training, the client trains locally for a certain amount of epochs before sharing his weights to the server/neighbor, this
- * is what we call a round.
- *
- * The role of the RoundTracker is to keep track of when a roundHasEnded using the current batch number. The batch in the RoundTracker is cumulative whereas
- * in the onBatchEnd it is not (it resets to 0 after each epoch).
- *
- * The roundDuration is the length of a round (in batches).
- */
-var RoundTracker = /** @class */ (function () {
-    function RoundTracker(roundDuration) {
-        this.round = 0;
-        this.batch = 0;
-        this.roundDuration = roundDuration;
-    }
-    /**
-     * Update the batch number, to be called inside onBatchEnd. (We do not use batch output of onBatchEnd since it is
-     * not cumulative).
-     */
-    RoundTracker.prototype.updateBatch = function () {
-        this.batch += 1;
-    };
-    /**
-     * Returns true if a local round has ended, false otherwise.
-     *
-     * @remark
-     * Returns true if (batch) mod (batches per round) == 0, false otherwise
-     */
-    RoundTracker.prototype.roundHasEnded = function () {
-        if (this.batch === 0) {
-            return false;
-        }
-        var roundHasEnded = this.batch % this.roundDuration === 0;
-        if (roundHasEnded) {
-            this.round += 1;
-        }
-        return roundHasEnded;
-    };
-    return RoundTracker;
-}());
-exports.RoundTracker = RoundTracker;

package/dist/core/training/trainer/trainer.d.ts

@@ -1,65 +0,0 @@
-import { tf, Memory, Task, TrainingInformant, TrainingInformation } from '../..';
-import { RoundTracker } from './round_tracker';
-import { TrainerLog } from '../../logging/trainer_logger';
-/** Abstract class whose role is to train a model with a given dataset. This can be either done
- * locally (alone) or in a distributed way with collaborators. The Trainer works as follows:
- *
- * 1. Call trainModel(dataset) to start training
- * 2. Once a batch ends, onBatchEnd is triggered, which will then call onRoundEnd once the round has ended.
- *
- * The onRoundEnd needs to be implemented to specify what actions to do when the round has ended, such as a communication step with collaborators. To know when
- * a round has ended we use the roundTracker object.
- */
-export declare abstract class Trainer {
-    readonly task: Task;
-    readonly trainingInformant: TrainingInformant;
-    readonly memory: Memory;
-    readonly model: tf.LayersModel;
-    readonly trainingInformation: TrainingInformation;
-    readonly roundTracker: RoundTracker;
-    private stopTrainingRequested;
-    private readonly trainerLogger;
-    /**
-     * Constructs the training manager.
-     * @param task the trained task
-     * @param trainingInformant the training informant
-     */
-    constructor(task: Task, trainingInformant: TrainingInformant, memory: Memory, model: tf.LayersModel);
-    /**
-     * Every time a round ends this function will be called
-     */
-    protected abstract onRoundEnd(accuracy: number): Promise<void>;
-    /** onBatchEnd callback, when a round ends, we call onRoundEnd (to be implemented for local and distributed instances)
-     */
-    protected onBatchEnd(_: number, logs?: tf.Logs): Promise<void>;
-    /**
-     * We update the training graph, this needs to be done on epoch end as there is no validation accuracy onBatchEnd.
-     */
-    protected onEpochEnd(epoch: number, logs?: tf.Logs): void;
-    /**
-     * When the training ends this function will be call
-     */
-    protected onTrainEnd(logs?: tf.Logs): Promise<void>;
-    /**
-     * Request stop training to be used from the Disco instance or any class that is taking care of the trainer.
-     */
-    stopTraining(): Promise<void>;
-    /**
-     * Start training the model with the given dataset
-     * @param dataset
-     */
-    trainModel(dataset: tf.data.Dataset<tf.TensorContainer>, valDataset: tf.data.Dataset<tf.TensorContainer>): Promise<void>;
-    /**
-     * Format accuracy
-     */
-    protected roundDecimals(accuracy: number, decimalsToRound?: number): number;
-    /**
-     * reset stop training state
-     */
-    protected resetStopTrainerState(): void;
-    /**
-     * If stop training is requested, do so
-     */
-    protected stopTrainModelIfRequested(): void;
-    getTrainerLog(): TrainerLog;
-}