Source: eclairjs/ml/feature/OneHotEncoder.js

  1. /*                                                                         
  2.  * Copyright 2016 IBM Corp.
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  *      http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  */
  17. (function () {
  19.     var Transformer = require(EclairJS_Globals.NAMESPACE + '/ml/Transformer');
  20.     var Logger = require(EclairJS_Globals.NAMESPACE + '/Logger');
  21.     var Utils = require(EclairJS_Globals.NAMESPACE + '/Utils');
  24.     /**
  25.      * @classdesc
  26.      * A one-hot encoder that maps a column of category indices to a column of binary vectors, with
  27.      * at most a single one-value per row that indicates the input category index.
  28.      * For example with 5 categories, an input value of 2.0 would map to an output vector of
  29.      * `[0.0, 0.0, 1.0, 0.0]`.
  30.      * The last category is not included by default (configurable via OneHotEncoder!.dropLast
  31.      * because it makes the vector entries sum up to one, and hence linearly dependent.
  32.      * So an input value of 4.0 maps to `[0.0, 0.0, 0.0, 0.0]`.
  33.      * Note that this is different from scikit-learn's OneHotEncoder, which keeps all categories.
  34.      * The output vectors are sparse.
  35.      *
  36.      * @see {@link module:eclairjs/ml/feature.StringIndexer} for converting categorical values into category indices
  37.      * @class
  38.      * @extends module:eclairjs/ml.Transformer
  39.      * @memberof module:eclairjs/ml/feature
  40.      * @param {string} [uid]
  41.      */
  42.     var OneHotEncoder = function (uid) {
  43.         this.logger = Logger.getLogger("ml_feature_OneHotEncoder_js");
  44.         var jvmObject;
  45.         if (uid) {
  46.             if (uid instanceof org.apache.spark.ml.feature.OneHotEncoder) {
  47.                 jvmObject = uid;
  48.             } else {
  49.                 jvmObject = new org.apache.spark.ml.feature.OneHotEncoder(uid);
  50.             }
  51.         } else {
  52.             jvmObject = new org.apache.spark.ml.feature.OneHotEncoder();
  53.         }
  54.         Transformer.call(this, jvmObject);
  56.     };
  58.     OneHotEncoder.prototype = Object.create(Transformer.prototype);
  60.     OneHotEncoder.prototype.constructor = OneHotEncoder;
  62.     /**
  63.      * An immutable unique ID for the object and its derivatives.
  64.      * @returns {string}
  65.      */
  66.     OneHotEncoder.prototype.uid = function () {
  67.         return this.getJavaObject().uid();
  68.     };
  70.     /**
  71.      * @returns {module:eclairjs/ml/param.BooleanParam}
  72.      */
  73.     OneHotEncoder.prototype.dropLast = function () {
  74.         var javaObject = this.getJavaObject().dropLast();
  75.         return Utils.javaToJs(javaObject);
  76.     };
  78.     /**
  79.      * @param {boolean} value
  80.      * @returns {module:eclairjs/ml/feature.OneHotEncoder}
  81.      */
  82.     OneHotEncoder.prototype.setDropLast = function (value) {
  83.         var javaObject = this.getJavaObject().setDropLast(value);
  84.         return new OneHotEncoder(javaObject);
  85.     };
  87.     /**
  88.        * @returns {boolean}
  89.       */
  90.      OneHotEncoder.prototype.getDropLast = function() {
  91.         return  this.getJavaObject().getDropLast();
  92.     };
  94.     /**
  95.      * @param {string} value
  96.      * @returns {module:eclairjs/ml/feature.OneHotEncoder}
  97.      */
  98.     OneHotEncoder.prototype.setInputCol = function (value) {
  99.         var javaObject = this.getJavaObject().setInputCol(value);
  100.         return new OneHotEncoder(javaObject);
  101.     };
  104.     /**
  105.      * @param {string} value
  106.      * @returns {module:eclairjs/ml/feature.OneHotEncoder}
  107.      */
  108.     OneHotEncoder.prototype.setOutputCol = function (value) {
  109.         var javaObject = this.getJavaObject().setOutputCol(value);
  110.         return new OneHotEncoder(javaObject);
  111.     };
  114.     /**
  115.      * @param {module:eclairjs/ml/param.ParamMap} extra
  116.      * @returns {module:eclairjs/ml/feature.OneHotEncoder}
  117.      */
  118.     OneHotEncoder.prototype.copy = function (extra) {
  119.         var extra_uw = Utils.unwrapObject(extra);
  120.         var javaObject = this.getJavaObject().copy(extra_uw);
  121.         return new OneHotEncoder(javaObject);
  122.     };
  124.     //
  125.     // static methods
  126.     //
  129.     /**
  130.      * @param {string} path
  131.      * @returns {module:eclairjs/ml/feature.OneHotEncoder}
  132.      */
  133.     OneHotEncoder.load = function (path) {
  134.         var javaObject = org.apache.spark.ml.feature.OneHotEncoder.load(path);
  135.         return new OneHotEncoder(javaObject);
  136.     };
  138.     module.exports = OneHotEncoder;
  139. })();