nlptoolkit-classification 1.0.6 → 1.0.8

package/dist/Model/NeuralNetwork/MultiLayerPerceptronModel.d.ts

@@ -0,0 +1,39 @@
+import { LinearPerceptronModel } from "./LinearPerceptronModel";
+import { ActivationFunction } from "../../Parameter/ActivationFunction";
+import { InstanceList } from "../../InstanceList/InstanceList";
+import { Parameter } from "../../Parameter/Parameter";
+export declare class MultiLayerPerceptronModel extends LinearPerceptronModel {
+    private V;
+    protected activationFunction: ActivationFunction;
+    /**
+     * The allocateWeights method allocates layers' weights of Matrix W and V.
+     *
+     * @param H Integer value for weights.
+     * @param random Random function to set weights.
+     */
+    private allocateWeights;
+    /**
+     * Loads a multi-layer perceptron model from an input model file.
+     * @param fileName Model file name.
+     */
+    constructor2(fileName: string): void;
+    /**
+     * The calculateOutput method calculates the forward single hidden layer by using Matrices W and V.
+     */
+    protected calculateOutput(): void;
+    saveTxt(fileName: string): void;
+    /**
+     * Training algorithm for the multilayer perceptron algorithm. 20 percent of the data is separated as cross-validation
+     * data used for selecting the best weights. 80 percent of the data is used for training the multilayer perceptron with
+     * gradient descent.
+     *
+     * @param train   Training data given to the algorithm
+     * @param params Parameters of the multilayer perceptron.
+     */
+    train(train: InstanceList, params: Parameter): void;
+    /**
+     * Loads the multi-layer perceptron model from an input file.
+     * @param fileName File name of the multi-layer perceptron model.
+     */
+    loadModel(fileName: string): void;
+}

package/dist/Model/{MultiLayerPerceptronModel.js → NeuralNetwork/MultiLayerPerceptronModel.js}

@@ -4,7 +4,7 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "./LinearPerceptronModel", "nlptoolkit-math/dist/Matrix", "../Parameter/ActivationFunction", "../InstanceList/InstanceList", "../Performance/ClassificationPerformance", "nlptoolkit-math/dist/Vector", "nlptoolkit-util/dist/Random", "nlptoolkit-util/dist/FileContents"], factory);
+        define(["require", "exports", "./LinearPerceptronModel", "nlptoolkit-math/dist/Matrix", "../../Parameter/ActivationFunction", "../../Performance/ClassificationPerformance", "nlptoolkit-math/dist/Vector", "nlptoolkit-util/dist/Random", "nlptoolkit-util/dist/FileContents", "../../InstanceList/Partition"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -12,33 +12,13 @@
     exports.MultiLayerPerceptronModel = void 0;
     const LinearPerceptronModel_1 = require("./LinearPerceptronModel");
     const Matrix_1 = require("nlptoolkit-math/dist/Matrix");
-    const ActivationFunction_1 = require("../Parameter/ActivationFunction");
-    const InstanceList_1 = require("../InstanceList/InstanceList");
-    const ClassificationPerformance_1 = require("../Performance/ClassificationPerformance");
+    const ActivationFunction_1 = require("../../Parameter/ActivationFunction");
+    const ClassificationPerformance_1 = require("../../Performance/ClassificationPerformance");
     const Vector_1 = require("nlptoolkit-math/dist/Vector");
     const Random_1 = require("nlptoolkit-util/dist/Random");
     const FileContents_1 = require("nlptoolkit-util/dist/FileContents");
+    const Partition_1 = require("../../InstanceList/Partition");
     class MultiLayerPerceptronModel extends LinearPerceptronModel_1.LinearPerceptronModel {
-        /**
-         * A constructor that takes {@link InstanceList}s as trainsSet and validationSet. It  sets the {@link NeuralNetworkModel}
-         * nodes with given {@link InstanceList} then creates an input vector by using given trainSet and finds error.
-         * Via the validationSet it finds the classification performance and reassigns the allocated weight Matrix with the matrix
-         * that has the best accuracy and the Matrix V with the best Vector input.
-         *
-         * @param trainSetOrFileName      InstanceList that is used to train.
-         * @param validationSet InstanceList that is used to validate.
-         * @param parameters    Multi layer perceptron parameters; seed, learningRate, etaDecrease, crossValidationRatio, epoch, hiddenNodes.
-         */
-        constructor(trainSetOrFileName, validationSet, parameters) {
-            if (trainSetOrFileName instanceof InstanceList_1.InstanceList) {
-                super(trainSetOrFileName);
-                this.constructor1(trainSetOrFileName, validationSet, parameters);
-            }
-            else {
-                super();
-                this.constructor2(trainSetOrFileName);
-            }
-        }
         /**
          * The allocateWeights method allocates layers' weights of Matrix W and V.
          *
@@ -49,7 +29,39 @@
             this.W = this.allocateLayerWeights(H, this.d + 1, random);
             this.V = this.allocateLayerWeights(this.K, H + 1, random);
         }
-        constructor1(trainSet, validationSet, parameters) {
+        /**
+         * Loads a multi-layer perceptron model from an input model file.
+         * @param fileName Model file name.
+         */
+        constructor2(fileName) {
+            let input = new FileContents_1.FileContents(fileName);
+            this.loadClassLabels(input);
+            this.W = this.loadMatrix(input);
+            this.V = this.loadMatrix(input);
+            this.activationFunction = this.loadActivationFunction(input);
+        }
+        /**
+         * The calculateOutput method calculates the forward single hidden layer by using Matrices W and V.
+         */
+        calculateOutput() {
+            this.calculateForwardSingleHiddenLayer(this.W, this.V, this.activationFunction);
+        }
+        saveTxt(fileName) {
+        }
+        /**
+         * Training algorithm for the multilayer perceptron algorithm. 20 percent of the data is separated as cross-validation
+         * data used for selecting the best weights. 80 percent of the data is used for training the multilayer perceptron with
+         * gradient descent.
+         *
+         * @param train   Training data given to the algorithm
+         * @param params Parameters of the multilayer perceptron.
+         */
+        train(train, params) {
+            this.initialize(train);
+            let parameters = params;
+            let partition = new Partition_1.Partition(train, parameters.getCrossValidationRatio(), true);
+            let trainSet = partition.get(1);
+            let validationSet = partition.get(1);
             this.activationFunction = parameters.getActivationFunction();
             this.allocateWeights(parameters.getHiddenNodes(), new Random_1.Random(parameters.getSeed()));
             let bestW = this.W.clone();
@@ -102,20 +114,12 @@
             this.W = bestW;
             this.V = bestV;
         }
-        constructor2(fileName) {
-            let input = new FileContents_1.FileContents(fileName);
-            this.loadClassLabels(input);
-            this.W = this.loadMatrix(input);
-            this.V = this.loadMatrix(input);
-            this.activationFunction = this.loadActivationFunction(input);
-        }
         /**
-         * The calculateOutput method calculates the forward single hidden layer by using Matrices W and V.
+         * Loads the multi-layer perceptron model from an input file.
+         * @param fileName File name of the multi-layer perceptron model.
          */
-        calculateOutput() {
-            this.calculateForwardSingleHiddenLayer(this.W, this.V, this.activationFunction);
-        }
-        saveTxt(fileName) {
+        loadModel(fileName) {
+            this.constructor2(fileName);
         }
     }
     exports.MultiLayerPerceptronModel = MultiLayerPerceptronModel;

package/dist/Model/NeuralNetwork/MultiLayerPerceptronModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultiLayerPerceptronModel.js","sourceRoot":"","sources":["../../../source/Model/NeuralNetwork/MultiLayerPerceptronModel.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,mEAA8D;IAC9D,wDAAmD;IACnD,2EAAsE;IAGtE,2FAAsF;IACtF,wDAAmD;IACnD,wDAAmD;IACnD,oEAA+D;IAE/D,4DAAuD;IAEvD,MAAa,yBAA0B,SAAQ,6CAAqB;QAKhE;;;;;WAKG;QACK,eAAe,CAAC,CAAS,EAAE,MAAc;YAC7C,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;YAC1D,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;QAC9D,CAAC;QAED;;;WAGG;QACH,YAAY,CAAC,QAAgB;YACzB,IAAI,KAAK,GAAG,IAAI,2BAAY,CAAC,QAAQ,CAAC,CAAA;YACtC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAA;YAC3B,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;YAC/B,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;YAC/B,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAA;QAChE,CAAC;QAED;;WAEG;QACO,eAAe;YACrB,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACpF,CAAC;QAED,OAAO,CAAC,QAAgB;QACxB,CAAC;QAED;;;;;;;WAOG;QACH,KAAK,CAAC,KAAmB,EAAE,MAAiB;YACxC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;YACtB,IAAI,UAAU,GAAoC,MAAO,CAAA;YACzD,IAAI,SAAS,GAAG,IAAI,qBAAS,CAAC,KAAK,EAAE,UAAU,CAAC,uBAAuB,EAAE,EAAE,IAAI,CAAC,CAAC;YACjF,IAAI,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;YAC/B,IAAI,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;YACpC,IAAI,CAAC,kBAAkB,GAAG,UAAU,CAAC,qBAAqB,EAAE,CAAC;YAC7D,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,IAAI,eAAM,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YACpF,IAAI,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;YAC3B,IAAI,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;YAC3B,IAAI,6BAA6B,GAAG,IAAI,qDAAyB,CAAC,GAAG,CAAC,CAAC;YACvE,IAAI,KAAK,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC;YAClC,IAAI,YAAY,GAAG,UAAU,CAAC,eAAe,EAAE,CAAC;YAChD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE;gBAC5B,QAAQ,CAAC,OAAO,CAAC,IAAI,eAAM,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;gBACnD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE;oBACtC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;oBACxC,IAAI,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;oBAC3E,IAAI,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;oBACnC,IAAI,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;oBAC3E,IAAI,MAAM,GAAG,IAAI,eAAM,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;oBAC/C,IAAI,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;oBACtD,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;oBACf,IAAI,oBAAoB,CAAA;oBACxB,QAAQ,IAAI,CAAC,kBAAkB,EAAC;wBAC5B,KAAK,uCAAkB,CAAC,OAAO,CAAC;wBAChC;4BACI,IAAI,cAAc,GAAG,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;4BAC1D,oBAAoB,GAAG,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;4BAC7D,MAAM;wBACV,KAAK,uCAAkB,CAAC,IAAI;4BACxB,IAAI,GAAG,GAAG,IAAI,eAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;4BACzC,MAAM,CAAC,IAAI,EAAE,CAAC;4BACd,oBAAoB,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;4BACrE,MAAM;wBACV,KAAK,uCAAkB,CAAC,IAAI;4BACxB,MAAM,CAAC,cAAc,EAAE,CAAC;4BACxB,oBAAoB,GAAG,MAAM,CAAC;4BAC9B,MAAM;qBACb;oBACD,IAAI,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;oBAC1D,IAAI,MAAM,GAAG,IAAI,eAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;oBAC3C,MAAM,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;oBAC1C,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;oBACnB,MAAM,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;oBAC1C,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;iBACtB;gBACD,IAAI,gCAAgC,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;gBAC1E,IAAI,gCAAgC,CAAC,WAAW,EAAE,GAAG,6BAA6B,CAAC,WAAW,EAAE,EAAE;oBAC9F,6BAA6B,GAAG,gCAAgC,CAAC;oBACjE,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;oBACvB,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;iBAC1B;gBACD,YAAY,IAAI,UAAU,CAAC,cAAc,EAAE,CAAC;aAC/C;YACD,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC;YACf,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC;QACnB,CAAC;QAED;;;WAGG;QACH,SAAS,CAAC,QAAgB;YACtB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QAC/B,CAAC;KAEJ;IAjHD,8DAiHC"}

package/dist/Model/{NeuralNetworkModel.d.ts → NeuralNetwork/NeuralNetworkModel.d.ts}

@@ -1,9 +1,9 @@
-import { ValidatedModel } from "./ValidatedModel";
+import { ValidatedModel } from "../ValidatedModel";
 import { Vector } from "nlptoolkit-math/dist/Vector";
-import { InstanceList } from "../InstanceList/InstanceList";
+import { InstanceList } from "../../InstanceList/InstanceList";
 import { Matrix } from "nlptoolkit-math/dist/Matrix";
-import { Instance } from "../Instance/Instance";
-import { ActivationFunction } from "../Parameter/ActivationFunction";
+import { Instance } from "../../Instance/Instance";
+import { ActivationFunction } from "../../Parameter/ActivationFunction";
 import { Random } from "nlptoolkit-util/dist/Random";
 import { FileContents } from "nlptoolkit-util/dist/FileContents";
 export declare abstract class NeuralNetworkModel extends ValidatedModel {
@@ -19,7 +19,7 @@ export declare abstract class NeuralNetworkModel extends ValidatedModel {
      *
      * @param trainSet {@link InstanceList} to use as train set.
      */
-    protected constructor(trainSet?: InstanceList);
+    protected initialize(trainSet: InstanceList): void;
     /**
      * The allocateLayerWeights method returns a new {@link Matrix} with random weights.
      *
@@ -98,7 +98,21 @@ export declare abstract class NeuralNetworkModel extends ValidatedModel {
      * @return The class label which has the maximum y.
      */
     predict(instance: Instance): string;
+    /**
+     * Calculates the posterior probability distribution for the given instance according to neural network model.
+     * @param instance Instance for which posterior probability distribution is calculated.
+     * @return Posterior probability distribution for the given instance.
+     */
     predictProbability(instance: Instance): Map<string, number>;
+    /**
+     * Loads the class labels from input model file.
+     * @param input Input model file.
+     */
     loadClassLabels(input: FileContents): void;
+    /**
+     * Loads the activation function from an input model file.
+     * @param input Input model file.
+     * @return Activation function read.
+     */
     loadActivationFunction(input: FileContents): ActivationFunction;
 }

package/dist/Model/{NeuralNetworkModel.js → NeuralNetwork/NeuralNetworkModel.js}

@@ -4,25 +4,24 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "./ValidatedModel", "nlptoolkit-math/dist/Vector", "nlptoolkit-math/dist/Matrix", "../Parameter/ActivationFunction", "../Instance/CompositeInstance"], factory);
+        define(["require", "exports", "../ValidatedModel", "nlptoolkit-math/dist/Vector", "nlptoolkit-math/dist/Matrix", "../../Parameter/ActivationFunction", "../../Instance/CompositeInstance"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.NeuralNetworkModel = void 0;
-    const ValidatedModel_1 = require("./ValidatedModel");
+    const ValidatedModel_1 = require("../ValidatedModel");
     const Vector_1 = require("nlptoolkit-math/dist/Vector");
     const Matrix_1 = require("nlptoolkit-math/dist/Matrix");
-    const ActivationFunction_1 = require("../Parameter/ActivationFunction");
-    const CompositeInstance_1 = require("../Instance/CompositeInstance");
+    const ActivationFunction_1 = require("../../Parameter/ActivationFunction");
+    const CompositeInstance_1 = require("../../Instance/CompositeInstance");
     class NeuralNetworkModel extends ValidatedModel_1.ValidatedModel {
         /**
          * Constructor that sets the class labels, their sizes as K and the size of the continuous attributes as d.
          *
          * @param trainSet {@link InstanceList} to use as train set.
          */
-        constructor(trainSet) {
-            super();
+        initialize(trainSet) {
             if (trainSet != undefined) {
                 this.classLabels = trainSet.getDistinctClassLabels();
                 this.K = this.classLabels.length;
@@ -168,6 +167,11 @@
                 return this.classLabels[this.y.maxIndex()];
             }
         }
+        /**
+         * Calculates the posterior probability distribution for the given instance according to neural network model.
+         * @param instance Instance for which posterior probability distribution is calculated.
+         * @return Posterior probability distribution for the given instance.
+         */
         predictProbability(instance) {
             this.createInputVector(instance);
             this.calculateOutput();
@@ -177,6 +181,10 @@
             }
             return result;
         }
+        /**
+         * Loads the class labels from input model file.
+         * @param input Input model file.
+         */
         loadClassLabels(input) {
             let items = input.readLine().split(" ");
             this.K = parseInt(items[0]);
@@ -186,6 +194,11 @@
                 this.classLabels.push(input.readLine());
             }
         }
+        /**
+         * Loads the activation function from an input model file.
+         * @param input Input model file.
+         * @return Activation function read.
+         */
         loadActivationFunction(input) {
             switch (input.readLine()) {
                 case "TANH":

package/dist/Model/NeuralNetwork/NeuralNetworkModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NeuralNetworkModel.js","sourceRoot":"","sources":["../../../source/Model/NeuralNetwork/NeuralNetworkModel.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,sDAAiD;IACjD,wDAAmD;IAEnD,wDAAmD;IAEnD,2EAAsE;IACtE,wEAAmE;IAInE,MAAsB,kBAAmB,SAAQ,+BAAc;QAW3D;;;;WAIG;QACO,UAAU,CAAC,QAAsB;YACvC,IAAI,QAAQ,IAAI,SAAS,EAAC;gBACtB,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,sBAAsB,EAAE,CAAA;gBACpD,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAA;gBAChC,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,uBAAuB,EAAE,CAAA;aACrD;QACL,CAAC;QAED;;;;;;;WAOG;QACO,oBAAoB,CAAC,GAAW,EAAE,MAAc,EAAE,MAAc;YACtE,OAAO,IAAI,eAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACzD,CAAC;QAED;;;;;;WAMG;QACO,eAAe,CAAC,CAAS;YAC/B,IAAI,GAAG,GAAG,GAAG,CAAC;YACd,IAAI,MAAM,GAAG,IAAI,KAAK,EAAU,CAAA;YAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAC;gBAC9B,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;aAClC;YACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAC;gBAC9B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;aAC9C;YACD,OAAO,IAAI,eAAM,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC;QAED;;;;;WAKG;QACO,iBAAiB,CAAC,QAAkB;YAC1C,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;YAC7B,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAC1B,CAAC;QAED;;;;;;;;WAQG;QACO,eAAe,CAAC,KAAa,EAAE,OAAe,EAAE,kBAAsC;YAC5F,IAAI,CAAC,GAAG,OAAO,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;YACnD,QAAQ,kBAAkB,EAAC;gBACvB,KAAK,uCAAkB,CAAC,OAAO,CAAC;gBAChC;oBACI,CAAC,CAAC,OAAO,EAAE,CAAC;oBACZ,MAAM;gBACV,KAAK,uCAAkB,CAAC,IAAI;oBACxB,CAAC,CAAC,IAAI,EAAE,CAAC;oBACT,MAAM;gBACV,KAAK,uCAAkB,CAAC,IAAI;oBACxB,CAAC,CAAC,IAAI,EAAE,CAAC;oBACT,MAAM;aACb;YACD,OAAO,CAAC,CAAC;QACb,CAAC;QAED;;;;;;WAMG;QACO,uBAAuB,CAAC,MAAc;YAC5C,IAAI,GAAG,GAAG,IAAI,eAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;YACzC,OAAO,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC;QAED;;;;;;;WAOG;QACO,iCAAiC,CAAC,CAAS,EAAE,CAAS,EAAE,kBAAsC;YACpG,IAAI,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;YACjE,IAAI,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;QACzD,CAAC;QAED;;;;;;;;;WASG;QACO,gBAAgB,CAAC,QAAkB,EAAE,KAAa,EAAE,OAAe;YACzE,IAAI,CAAC,CAAC,GAAG,IAAI,eAAM,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;YACrF,IAAI,CAAC,GAAG,OAAO,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;YACnD,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YACjC,OAAO,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC;QAED;;;;;;WAMG;QACO,4BAA4B,CAAC,mBAAkC;YACrE,IAAI,cAAc,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;YAC5C,IAAI,IAAI,GAAG,MAAM,CAAC,iBAAiB,CAAA;YACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC9C,IAAI,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE;oBAChF,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;oBAC1B,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;iBACxC;aACJ;YACD,OAAO,cAAc,CAAC;QAC1B,CAAC;QAED;;;;;;WAMG;QACH,OAAO,CAAC,QAAkB;YACtB,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;YACjC,IAAI,CAAC,eAAe,EAAE,CAAC;YACvB,IAAI,QAAQ,YAAY,qCAAiB,EAAE;gBACvC,OAAO,IAAI,CAAC,4BAA4B,CAAsB,QAAS,CAAC,sBAAsB,EAAE,CAAC,CAAC;aACrG;iBAAM;gBACH,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;aAC9C;QACL,CAAC;QAED;;;;WAIG;QACH,kBAAkB,CAAC,QAAkB;YACjC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;YACjC,IAAI,CAAC,eAAe,EAAE,CAAC;YACvB,IAAI,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;YACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAC;gBAC7C,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;aACvD;YACD,OAAO,MAAM,CAAC;QAClB,CAAC;QAED;;;WAGG;QACH,eAAe,CAAC,KAAmB;YAC/B,IAAI,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACvC,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YAC3B,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YAC3B,IAAI,CAAC,WAAW,GAAG,IAAI,KAAK,EAAU,CAAA;YACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,EAAC;gBAC5B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;aAC1C;QACL,CAAC;QAED;;;;WAIG;QACH,sBAAsB,CAAC,KAAmB;YACtC,QAAQ,KAAK,CAAC,QAAQ,EAAE,EAAC;gBACrB,KAAK,MAAM;oBACP,OAAO,uCAAkB,CAAC,IAAI,CAAA;gBAClC,KAAK,MAAM;oBACP,OAAO,uCAAkB,CAAC,IAAI,CAAA;gBAClC;oBACI,OAAO,uCAAkB,CAAC,OAAO,CAAA;aACxC;QACL,CAAC;KACJ;IAvND,gDAuNC"}

package/dist/Model/{KnnInstance.d.ts → NonParametric/KnnInstance.d.ts}

@@ -1,4 +1,4 @@
-import { Instance } from "../Instance/Instance";
+import { Instance } from "../../Instance/Instance";
 export declare class KnnInstance {
     private readonly distance;
     private readonly instance;

package/dist/Model/NonParametric/KnnInstance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnnInstance.js","sourceRoot":"","sources":["../../../source/Model/NonParametric/KnnInstance.ts"],"names":[],"mappings":";;;;;;;;;;;;IAEA,MAAa,WAAW;QAKpB;;;;;WAKG;QACH,YAAY,QAAkB,EAAE,QAAgB;YAC5C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC7B,CAAC;QAED,WAAW;YACP,OAAO,IAAI,CAAC,QAAQ,CAAA;QACxB,CAAC;QAED,WAAW;YACP,OAAO,IAAI,CAAC,QAAQ,CAAA;QACxB,CAAC;KAEJ;IAxBD,kCAwBC"}

package/dist/Model/{KnnModel.d.ts → NonParametric/KnnModel.d.ts}

@@ -1,7 +1,8 @@
-import { Model } from "./Model";
-import { InstanceList } from "../InstanceList/InstanceList";
-import { Instance } from "../Instance/Instance";
-import { DistanceMetric } from "../DistanceMetric/DistanceMetric";
+import { Model } from "../Model";
+import { InstanceList } from "../../InstanceList/InstanceList";
+import { Instance } from "../../Instance/Instance";
+import { DistanceMetric } from "../../DistanceMetric/DistanceMetric";
+import { Parameter } from "../../Parameter/Parameter";
 export declare class KnnModel extends Model {
     private data;
     private k;
@@ -9,11 +10,16 @@ export declare class KnnModel extends Model {
     /**
      * Constructor that sets the data {@link InstanceList}, k value and the {@link DistanceMetric}.
      *
-     * @param dataOrFileName           {@link InstanceList} input.
+     * @param data           {@link InstanceList} input.
      * @param k              K value.
      * @param distanceMetric {@link DistanceMetric} input.
      */
-    constructor(dataOrFileName: InstanceList | string, k?: number, distanceMetric?: DistanceMetric);
+    constructor1(data: InstanceList, k: number, distanceMetric: DistanceMetric): void;
+    /**
+     * Loads a K-nearest neighbor model from an input model file.
+     * @param fileName Model file name.
+     */
+    constructor2(fileName: string): void;
     /**
      * The predict method takes an {@link Instance} as an input and finds the nearest neighbors of given instance. Then
      * it returns the first possible class label as the predicted class.
@@ -22,6 +28,11 @@ export declare class KnnModel extends Model {
      * @return The first possible class label as the predicted class.
      */
     predict(instance: Instance): string;
+    /**
+     * Calculates the posterior probability distribution for the given instance according to K-means model.
+     * @param instance Instance for which posterior probability distribution is calculated.
+     * @return Posterior probability distribution for the given instance.
+     */
     predictProbability(instance: Instance): Map<string, number>;
     /**
      * The nearestNeighbors method takes an {@link Instance} as an input. First it gets the possible class labels, then loops
@@ -34,4 +45,17 @@ export declare class KnnModel extends Model {
      */
     nearestNeighbors(instance: Instance): InstanceList;
     saveTxt(fileName: string): void;
+    /**
+     * Training algorithm for K-nearest neighbor classifier.
+     *
+     * @param trainSet   Training data given to the algorithm.
+     * @param parameters K: k parameter of the K-nearest neighbor algorithm
+     *                   distanceMetric: distance metric used to calculate the distance between two instances.
+     */
+    train(trainSet: InstanceList, parameters: Parameter): void;
+    /**
+     * Loads the K-nearest neighbor model from an input file.
+     * @param fileName File name of the K-nearest neighbor model.
+     */
+    loadModel(fileName: string): void;
 }

package/dist/Model/{KnnModel.js → NonParametric/KnnModel.js}

@@ -4,39 +4,40 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "./Model", "../InstanceList/InstanceList", "../Instance/CompositeInstance", "./KnnInstance", "../DistanceMetric/EuclidianDistance", "nlptoolkit-util/dist/FileContents"], factory);
+        define(["require", "exports", "../Model", "../../InstanceList/InstanceList", "../../Instance/CompositeInstance", "./KnnInstance", "../../DistanceMetric/EuclidianDistance", "nlptoolkit-util/dist/FileContents"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.KnnModel = void 0;
-    const Model_1 = require("./Model");
-    const InstanceList_1 = require("../InstanceList/InstanceList");
-    const CompositeInstance_1 = require("../Instance/CompositeInstance");
+    const Model_1 = require("../Model");
+    const InstanceList_1 = require("../../InstanceList/InstanceList");
+    const CompositeInstance_1 = require("../../Instance/CompositeInstance");
     const KnnInstance_1 = require("./KnnInstance");
-    const EuclidianDistance_1 = require("../DistanceMetric/EuclidianDistance");
+    const EuclidianDistance_1 = require("../../DistanceMetric/EuclidianDistance");
     const FileContents_1 = require("nlptoolkit-util/dist/FileContents");
     class KnnModel extends Model_1.Model {
         /**
          * Constructor that sets the data {@link InstanceList}, k value and the {@link DistanceMetric}.
          *
-         * @param dataOrFileName           {@link InstanceList} input.
+         * @param data           {@link InstanceList} input.
          * @param k              K value.
          * @param distanceMetric {@link DistanceMetric} input.
          */
-        constructor(dataOrFileName, k, distanceMetric) {
-            super();
-            if (dataOrFileName instanceof InstanceList_1.InstanceList) {
-                this.data = dataOrFileName;
-                this.k = k;
-                this.distanceMetric = distanceMetric;
-            }
-            else {
-                this.distanceMetric = new EuclidianDistance_1.EuclidianDistance();
-                let input = new FileContents_1.FileContents(dataOrFileName);
-                this.k = parseInt(input.readLine());
-                this.data = this.loadInstanceList(input);
-            }
+        constructor1(data, k, distanceMetric) {
+            this.data = data;
+            this.k = k;
+            this.distanceMetric = distanceMetric;
+        }
+        /**
+         * Loads a K-nearest neighbor model from an input model file.
+         * @param fileName Model file name.
+         */
+        constructor2(fileName) {
+            this.distanceMetric = new EuclidianDistance_1.EuclidianDistance();
+            let input = new FileContents_1.FileContents(fileName);
+            this.k = parseInt(input.readLine());
+            this.data = this.loadInstanceList(input);
         }
         /**
          * The predict method takes an {@link Instance} as an input and finds the nearest neighbors of given instance. Then
@@ -56,6 +57,11 @@
             }
             return predictedClass;
         }
+        /**
+         * Calculates the posterior probability distribution for the given instance according to K-means model.
+         * @param instance Instance for which posterior probability distribution is calculated.
+         * @return Posterior probability distribution for the given instance.
+         */
         predictProbability(instance) {
             let nearestNeighbors = this.nearestNeighbors(instance);
             return nearestNeighbors.classDistribution().getProbabilityDistribution();
@@ -89,6 +95,23 @@
         }
         saveTxt(fileName) {
         }
+        /**
+         * Training algorithm for K-nearest neighbor classifier.
+         *
+         * @param trainSet   Training data given to the algorithm.
+         * @param parameters K: k parameter of the K-nearest neighbor algorithm
+         *                   distanceMetric: distance metric used to calculate the distance between two instances.
+         */
+        train(trainSet, parameters) {
+            this.constructor1(trainSet, parameters.getK(), parameters.getDistanceMetric());
+        }
+        /**
+         * Loads the K-nearest neighbor model from an input file.
+         * @param fileName File name of the K-nearest neighbor model.
+         */
+        loadModel(fileName) {
+            this.constructor2(fileName);
+        }
     }
     exports.KnnModel = KnnModel;
 });

package/dist/Model/NonParametric/KnnModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnnModel.js","sourceRoot":"","sources":["../../../source/Model/NonParametric/KnnModel.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,oCAA+B;IAC/B,kEAA6D;IAG7D,wEAAmE;IACnE,+CAA0C;IAC1C,8EAAyE;IACzE,oEAA+D;IAI/D,MAAa,QAAS,SAAQ,aAAK;QAM/B;;;;;;WAMG;QACH,YAAY,CAAC,IAAkB,EAAE,CAAS,EAAE,cAA8B;YACtE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAChB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;YACV,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;QACxC,CAAC;QAED;;;WAGG;QACH,YAAY,CAAC,QAAgB;YACzB,IAAI,CAAC,cAAc,GAAG,IAAI,qCAAiB,EAAE,CAAA;YAC7C,IAAI,KAAK,GAAG,IAAI,2BAAY,CAAC,QAAQ,CAAC,CAAA;YACtC,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;YACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAC5C,CAAC;QAED;;;;;;WAMG;QACH,OAAO,CAAC,QAAkB;YACtB,IAAI,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACvD,IAAI,cAAc,CAAA;YAClB,IAAI,QAAQ,YAAY,qCAAiB,IAAI,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE;gBACvE,cAAc,GAAwB,QAAS,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC,CAAC;aAC/E;iBAAM;gBACH,cAAc,GAAG,aAAK,CAAC,UAAU,CAAC,gBAAgB,CAAC,cAAc,EAAE,CAAC,CAAC;aACxE;YACD,OAAO,cAAc,CAAC;QAC1B,CAAC;QAED;;;;WAIG;QACH,kBAAkB,CAAC,QAAkB;YACjC,IAAI,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACvD,OAAO,gBAAgB,CAAC,iBAAiB,EAAE,CAAC,0BAA0B,EAAE,CAAC;QAC7E,CAAC;QAED;;;;;;;;WAQG;QACH,gBAAgB,CAAC,QAAkB;YAC/B,IAAI,MAAM,GAAG,IAAI,2BAAY,EAAE,CAAC;YAChC,IAAI,SAAS,GAAG,IAAI,KAAK,EAAe,CAAC;YACzC,IAAI,mBAAmB,GAAG,SAAS,CAAC;YACpC,IAAI,QAAQ,YAAY,qCAAiB,EAAE;gBACvC,mBAAmB,GAAwB,QAAS,CAAC,sBAAsB,EAAE,CAAC;aACjF;YACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE;gBACvC,IAAI,CAAC,CAAC,QAAQ,YAAY,qCAAiB,CAAC,IAAI,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,EAAE;oBAC5G,SAAS,CAAC,IAAI,CAAC,IAAI,yBAAW,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;iBAC/G;aACJ;YACD,SAAS,CAAC,IAAI,CAAC,CAAC,CAAc,EAAE,CAAc,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA,CAAC,CAAC,CAAC,CAAC,CAAC;YACtI,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE;gBACzD,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;aAC1C;YACD,OAAO,MAAM,CAAC;QAClB,CAAC;QAED,OAAO,CAAC,QAAgB;QACxB,CAAC;QAED;;;;;;WAMG;QACH,KAAK,CAAC,QAAsB,EAAE,UAAqB;YAC/C,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAkB,UAAW,CAAC,IAAI,EAAE,EAAkB,UAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACrH,CAAC;QAED;;;WAGG;QACH,SAAS,CAAC,QAAgB;YACtB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QAC/B,CAAC;KAEJ;IA5GD,4BA4GC"}

package/dist/Model/{GaussianModel.d.ts → Parametric/GaussianModel.d.ts}

@@ -1,6 +1,6 @@
 import { DiscreteDistribution } from "nlptoolkit-math/dist/DiscreteDistribution";
-import { Instance } from "../Instance/Instance";
-import { ValidatedModel } from "./ValidatedModel";
+import { Instance } from "../../Instance/Instance";
+import { ValidatedModel } from "../ValidatedModel";
 import { FileContents } from "nlptoolkit-util/dist/FileContents";
 import { Vector } from "nlptoolkit-math/dist/Vector";
 export declare abstract class GaussianModel extends ValidatedModel {
@@ -22,7 +22,25 @@ export declare abstract class GaussianModel extends ValidatedModel {
      * @return The class which has the maximum value of metric.
      */
     predict(instance: Instance): string;
+    /**
+     * Loads the prior probability distribution from an input model file.
+     * @param input Input model file.
+     * @return Prior probability distribution.
+     * @throws IOException If the input file can not be read, the method throws IOException.
+     */
     loadPriorDistribution(input: FileContents): number;
+    /**
+     * Loads hash map of vectors from input model file.
+     * @param input Input model file.
+     * @param size Number of vectors to be read from input model file.
+     * @return Hash map of vectors.
+     * @throws IOException If the input file can not be read, the method throws IOException.
+     */
     loadVectors(input: FileContents, size: number): Map<string, Vector>;
+    /**
+     * Calculates the posterior probability distribution for the given instance according to Gaussian model.
+     * @param instance Instance for which posterior probability distribution is calculated.
+     * @return Posterior probability distribution for the given instance.
+     */
     predictProbability(instance: Instance): Map<string, number>;
 }

package/dist/Model/{GaussianModel.js → Parametric/GaussianModel.js}

@@ -4,15 +4,15 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "nlptoolkit-math/dist/DiscreteDistribution", "./ValidatedModel", "../Instance/CompositeInstance", "nlptoolkit-math/dist/Vector"], factory);
+        define(["require", "exports", "nlptoolkit-math/dist/DiscreteDistribution", "../ValidatedModel", "../../Instance/CompositeInstance", "nlptoolkit-math/dist/Vector"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.GaussianModel = void 0;
     const DiscreteDistribution_1 = require("nlptoolkit-math/dist/DiscreteDistribution");
-    const ValidatedModel_1 = require("./ValidatedModel");
-    const CompositeInstance_1 = require("../Instance/CompositeInstance");
+    const ValidatedModel_1 = require("../ValidatedModel");
+    const CompositeInstance_1 = require("../../Instance/CompositeInstance");
     const Vector_1 = require("nlptoolkit-math/dist/Vector");
     class GaussianModel extends ValidatedModel_1.ValidatedModel {
         /**
@@ -52,6 +52,12 @@
             }
             return predictedClass;
         }
+        /**
+         * Loads the prior probability distribution from an input model file.
+         * @param input Input model file.
+         * @return Prior probability distribution.
+         * @throws IOException If the input file can not be read, the method throws IOException.
+         */
         loadPriorDistribution(input) {
             let size = parseInt(input.readLine());
             this.priorDistribution = new DiscreteDistribution_1.DiscreteDistribution();
@@ -64,6 +70,13 @@
             }
             return size;
         }
+        /**
+         * Loads hash map of vectors from input model file.
+         * @param input Input model file.
+         * @param size Number of vectors to be read from input model file.
+         * @return Hash map of vectors.
+         * @throws IOException If the input file can not be read, the method throws IOException.
+         */
         loadVectors(input, size) {
             let map = new Map();
             for (let i = 0; i < size; i++) {
@@ -77,6 +90,11 @@
             }
             return map;
         }
+        /**
+         * Calculates the posterior probability distribution for the given instance according to Gaussian model.
+         * @param instance Instance for which posterior probability distribution is calculated.
+         * @return Posterior probability distribution for the given instance.
+         */
         predictProbability(instance) {
             return undefined;
         }

package/dist/Model/Parametric/GaussianModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GaussianModel.js","sourceRoot":"","sources":["../../../source/Model/Parametric/GaussianModel.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,oFAA+E;IAE/E,sDAAiD;IACjD,wEAAmE;IAEnE,wDAAmD;IAEnD,MAAsB,aAAc,SAAQ,+BAAc;QAatD;;;;;;;WAOG;QACH,OAAO,CAAC,QAAkB;YACtB,IAAI,SAAS,GAAG,MAAM,CAAC,iBAAiB,CAAC;YACzC,IAAI,cAAc,EAAE,IAAI,CAAA;YACxB,IAAI,QAAQ,YAAY,qCAAiB,EAAE;gBACvC,cAAc,GAAwB,QAAS,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC5E,IAAI,GAAwB,QAAS,CAAC,sBAAsB,EAAE,CAAC,MAAM,CAAC;aACzE;iBAAM;gBACH,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;gBACrD,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC;aACtC;YACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE;gBAC3B,IAAI,EAAE,CAAA;gBACN,IAAI,QAAQ,YAAY,qCAAiB,EAAE;oBACvC,EAAE,GAAwB,QAAS,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC,CAAC;iBACnE;qBAAM;oBACH,EAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;iBAC1C;gBACD,IAAI,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE;oBACzC,IAAI,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;oBAChD,IAAI,MAAM,GAAG,SAAS,EAAE;wBACpB,SAAS,GAAG,MAAM,CAAC;wBACnB,cAAc,GAAG,EAAE,CAAC;qBACvB;iBACJ;aACJ;YACD,OAAO,cAAc,CAAC;QAC1B,CAAC;QAED;;;;;WAKG;QACH,qBAAqB,CAAC,KAAmB;YACrC,IAAI,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;YACrC,IAAI,CAAC,iBAAiB,GAAG,IAAI,2CAAoB,EAAE,CAAA;YACnD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAC;gBAC1B,IAAI,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;gBAC3B,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAC;oBACxC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;iBAC3C;aACJ;YACD,OAAO,IAAI,CAAA;QACf,CAAC;QAED;;;;;;WAMG;QACH,WAAW,CAAC,KAAmB,EAAE,IAAY;YACzC,IAAI,GAAG,GAAG,IAAI,GAAG,EAAkB,CAAA;YACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAC;gBAC1B,IAAI,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;gBAC3B,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;gBAC3B,IAAI,MAAM,GAAG,IAAI,eAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;gBAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAC;oBAClC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;iBAC/C;gBACD,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;aAC5B;YACD,OAAO,GAAG,CAAA;QACd,CAAC;QAED;;;;WAIG;QACH,kBAAkB,CAAC,QAAkB;YACjC,OAAO,SAAS,CAAC;QACrB,CAAC;KACJ;IAjGD,sCAiGC"}

package/dist/Model/Parametric/KMeansModel.d.ts

@@ -0,0 +1,36 @@
+import { GaussianModel } from "./GaussianModel";
+import { InstanceList } from "../../InstanceList/InstanceList";
+import { Instance } from "../../Instance/Instance";
+import { Parameter } from "../../Parameter/Parameter";
+export declare class KMeansModel extends GaussianModel {
+    private classMeans;
+    private distanceMetric;
+    /**
+     * Loads a K-means model from an input model file.
+     * @param fileName Model file name.
+     */
+    constructor2(fileName: string): void;
+    /**
+     * The calculateMetric method takes an {@link Instance} and a String as inputs. It loops through the class means, if
+     * the corresponding class label is same as the given String it returns the negated distance between given instance and the
+     * current item of class means. Otherwise it returns the smallest negative number.
+     *
+     * @param instance {@link Instance} input.
+     * @param Ci       String input.
+     * @return The negated distance between given instance and the current item of class means.
+     */
+    calculateMetric(instance: Instance, Ci: string): number;
+    saveTxt(fileName: string): void;
+    /**
+     * Training algorithm for K-Means classifier. K-Means finds the mean of each class for training.
+     *
+     * @param trainSet   Training data given to the algorithm.
+     * @param parameters distanceMetric: distance metric used to calculate the distance between two instances.
+     */
+    train(trainSet: InstanceList, parameters: Parameter): void;
+    /**
+     * Loads the K-means model from an input file.
+     * @param fileName File name of the K-means model.
+     */
+    loadModel(fileName: string): void;
+}