Source: set/xmm-set.js

  1. // An xmm-compatible training set must have the following fields :
  2. // - bimodal (boolean)
  3. // - column_names (array of strings)
  4. // - dimension (integer)
  5. // - dimension_input (integer < dimension)
  6. // - phrases (array of phrases)
  7. //   - on export, each phrase must have an extra "index" field
  8. //     => when the class returns a set with getPhrasesOfLabel or getTrainingSet,
  9. //        it should add these index fields before returning the result.
  10. //     => when a set is added with addTrainingSet, the indexes must be removed
  11. //        from the phrases before they are added to the internal array
  13. /**
  14.  * XMM compatible training set manager utility <br />
  15.  * Class to ease the creation of XMM compatible training sets. <br />
  16.  * Phrases should be generated with the PhraseMaker class or the original XMM library.
  17.  */
  18. class SetMaker {
  19.   constructor() {
  20.     this._config = {};
  21.     this._phrases = [];
  22.   }
  24.   /***
  25.    * The current total number of phrases in the set.
  26.    * @readonly
  27.    */
  28.   // get size() {
  29.   //   return this._phrases.length;
  30.   // }
  32.   /**
  33.    * A valid XMM training set, ready to be processed by the XMM library.
  34.    * @typedef xmmTrainingSet
  35.    * @type {Object}
  36.    * @name xmmTrainingSet
  37.    * @property {Boolean} bimodal - Indicates wether the set's phrases data should be considered bimodal.
  38.    * If true, the <code>dimension_input</code> property will be taken into account.
  39.    * @property {Number} dimension - Size of a vector element of the set's phrases.
  40.    * @property {Number} dimension_input - Size of the part of an input vector element that should be used for training.
  41.    * This implies that the rest of the vector (of size <code>dimension - dimension_input</code>)
  42.    * will be used for regression. Only taken into account if <code>bimodal</code> is true.
  43.    * @property {Array.String} column_names - Array of string identifiers describing each scalar of a phrase's vector elements.
  44.    * Typically of size <code>dimension</code>.
  45.    * @property {Array.xmmPhrase} phrases  - Array of valid XMM phrases containing an extra "index" field.
  46.    */
  48.   /**
  49.    * Get the total number of phrases actually in the set.
  50.    * @returns {Number}
  51.    */
  52.   getSize() {
  53.     return this._phrases.length;
  54.   }
  56.   /**
  57.    * Add an XMM phrase to the current set.
  58.    * @param {xmmPhrase} phrase - An XMM compatible phrase (ie created with the PhraseMaker class)
  59.    */
  60.   addPhrase(phrase) {
  61.     if (this._phrases.length === 0) {
  62.       this._setConfigFrom(phrase);
  63.     } else if (!this._checkCompatibility(phrase)) {
  64.       throw new Error('Bad phrase format: added phrase must match current set configuration');
  65.     }
  66.     this._phrases.push(JSON.parse(JSON.stringify(phrase)));
  67.   }
  69.   /**
  70.    * Add all phrases from another training set.
  71.    * @param {xmmTrainingSet} set - An XMM compatible training set.
  72.    */
  73.   addTrainingSet(set) {
  74.     if (this._phrases.length === 0) {
  75.       this._setConfigFrom(set);
  76.     } else if (!this._checkCompatibility(set)) {
  77.       throw new Error('Bad set format: added set must match current set configuration');
  78.     }
  80.     const phrases = set['phrases'];
  81.     for (let phrase of phrases) {
  82.       this._phrases.push(phrase);
  83.     }
  84.   }
  86.   /**
  87.    * Get phrase at a particular index.
  88.    * @param {Number} index - The index of the phrase to retrieve.
  89.    * @returns {xmmPhrase}
  90.    */
  91.   getPhrase(index) {
  92.     if (index > -1 && index < this._phrases.length) {
  93.       // return a new copy of the phrase :
  94.       return JSON.parse(JSON.stringify(this._phrases[index]));
  95.     }
  96.     return null;
  97.   }
  99.   /**
  100.    * Remove phrase at a particular index.
  101.    * @param {Number} index - The index of the phrase to remove.
  102.    */
  103.   removePhrase(index) {
  104.     if (index > -1 && index < this._phrases.length) {
  105.       this._phrases.splice(index, 1);
  106.     }
  107.   }
  109.   /**
  110.    * Return the subset of phrases of a particular label.
  111.    * @param {String} label - The label of the phrases from which to generate the sub-training set.
  112.    * @returns {xmmTrainingSet}
  113.    */
  114.   getPhrasesOfLabel(label) {
  115.     const res = {};
  117.     for (let prop in this._config) {
  118.       res[prop] = this._config[prop];
  119.     }
  121.     res['phrases'] = [];
  122.     let index = 0;
  124.     for (let phrase of this._phrases) {
  125.       if (phrase['label'] === label) {
  126.         let p = JSON.parse(JSON.stringify(phrase));
  127.         p['index'] = index++;
  128.         res['phrases'].push(p);
  129.       }
  130.     }
  132.     return res;
  133.   }
  135.   /**
  136.    * Remove all phrases of a particular label.
  137.    * @param {String} label - The label of the phrases to remove.
  138.    */
  139.   removePhrasesOfLabel(label) {
  140.     for (let i = this._phrases.length - 1; i >= 0; i--) {
  141.       if (this._phrases[i]['label'] === label) {
  142.         this._phrases.splice(i, 1);
  143.       }
  144.     }
  145.   }
  147.   /**
  148.    * Return the current training set.
  149.    * @returns {xmmTrainingSet}
  150.    */
  151.   getTrainingSet() {
  152.     let res = {};
  154.     for (let prop in this._config) {
  155.       res[prop] = this._config[prop];
  156.     }
  158.     res['phrases'] = [];
  159.     let index = 0;
  161.     for (let phrase of this._phrases) {
  162.       let p = JSON.parse(JSON.stringify(phrase));
  163.       p['index'] = index++;
  164.       res['phrases'].push(p);
  165.     }
  167.     return res;
  168.   }
  170.   /**
  171.    * Clear the whole set.
  172.    */
  173.   clear() {
  174.     this._config = {};
  175.     this._phrases = [];
  176.   }
  178.   /**
  179.    * Check the config of a phrase or training set before applying it
  180.    * to the current class.
  181.    * Throw errors if not valid ?
  182.    * @private
  183.    */
  184.   _setConfigFrom(obj) {
  185.     for (let prop in obj) {
  186.       if (prop === 'bimodal' && typeof(obj['bimodal']) === 'boolean') {
  187.         this._config[prop] = obj[prop];
  188.       } else if (prop === 'column_names' && Array.isArray(obj[prop])) {
  189.         this._config[prop] = obj[prop].slice(0);
  190.       } else if (prop === 'dimension' && Number.isInteger(obj[prop])) {
  191.         this._config[prop] = obj[prop];
  192.       } else if (prop === 'dimension_input' && Number.isInteger(obj[prop])) {
  193.         this._config[prop] = obj[prop];
  194.       }
  195.     }
  196.   }
  198.   /**
  199.    * Check if the phrase or set is compatible with the current settings.
  200.    * @private
  201.    */
  202.   _checkCompatibility(obj) {
  203.     if (obj['bimodal'] !== this._config['bimodal']
  204.       || obj['dimension'] !== this._config['dimension']
  205.       || obj['dimension_input'] !== this._config['dimension_input']) {
  206.       return false;
  207.     }
  209.     const ocn = obj['column_names'];
  210.     const ccn = this._config['column_names'];
  212.     if (ocn && ccn) {
  213.       if (ocn.length !== ccn.length) {
  214.         return false;
  215.       } else {
  216.         for (let i = 0; i < ocn.length; i++) {
  217.           if (ocn[i] !== ccn[i]) {
  218.             return false;
  219.           }
  220.         }
  221.       }
  222.     }
  224.     return true;
  225.   }
  226. };
  228. export default SetMaker;