Source: eclairjs/ml/regression/GBTRegressionModel.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 PredictionModel = require(EclairJS_Globals.NAMESPACE + '/ml/PredictionModel');
  20.     var Logger = require(EclairJS_Globals.NAMESPACE + '/Logger');
  21.     var Utils = require(EclairJS_Globals.NAMESPACE + '/Utils');
  24.     /**
  25.      * @classdesc
  26.      *
  27.      * [Gradient-Boosted Trees (GBTs)]{@link http://en.wikipedia.org/wiki/Gradient_boosting}
  28.      * model for regression.
  29.      * It supports both continuous and categorical features.
  30.      * @class
  31.      * @extends module:eclairjs/ml.PredictionModel
  32.      * @memberof module:eclairjs/ml/regression
  33.      * @oaram {string} uid
  34.      * @param {DecisionTreeRegressionModel[]} trees   Decision trees in the ensemble.
  35.      * @param {float[]} treeWeights   Weights for the decision trees in the ensemble.
  37.      */
  38.     var GBTRegressionModel = function (uid, trees, treeWeights) {
  39.         this.logger = Logger.getLogger("ml_regression_GBTRegressionModel_js");
  40.         var jvmObject;
  41.         if (uid instanceof org.apache.spark.ml.regression.GBTRegressionModel) {
  42.             jvmObject = uid;
  43.         } else {
  44.             var tress_uw = Utils.unwrapObject(trees);
  45.             jvmObject = new org.apache.spark.ml.regression.GBTRegressionModel(uid, tress_uw, treeWeights);
  46.         }
  47.         PredictionModel.call(this, jvmObject);
  49.     };
  51.     GBTRegressionModel.prototype = Object.create(PredictionModel.prototype);
  53.     GBTRegressionModel.prototype.constructor = GBTRegressionModel;
  56.     /**
  57.      * An immutable unique ID for the object and its derivatives.
  58.      * @returns {string}
  59.      */
  60.     GBTRegressionModel.prototype.uid = function () {
  61.         return this.getJavaObject().uid();
  62.     };
  64.     /**
  65.      * @returns {DecisionTreeModel[]}
  66.      */
  67.     GBTRegressionModel.prototype.trees = function () {
  68.         var javaObject = this.getJavaObject().trees();
  69.         return Utils.javaToJs(javaObject);
  70.     };
  73.     /**
  74.      * @returns {float[]}
  75.      */
  76.     GBTRegressionModel.prototype.treeWeights = function () {
  77.         return this.getJavaObject().treeWeights();
  78.     };
  81.     /**
  82.      * @param {module:eclairjs/ml/param.ParamMap} extra
  83.      * @returns {module:eclairjs/ml/regression.GBTRegressionModel}
  84.      */
  85.     GBTRegressionModel.prototype.copy = function (extra) {
  86.         var extra_uw = Utils.unwrapObject(extra);
  87.         var javaObject = this.getJavaObject().copy(extra_uw);
  88.         return new GBTRegressionModel(javaObject);
  89.     };
  92.     /**
  93.      * @returns {string}
  94.      */
  95.     GBTRegressionModel.prototype.toString = function () {
  96.         return this.getJavaObject().toString();
  97.     };
  99.     /**
  100.      * @returns {string}
  101.      */
  102.     GBTRegressionModel.prototype.toDebugString = function () {
  103.         return this.getJavaObject().toDebugString();
  104.     };
  106.     
  107.     /**
  108.      * @returns {module:eclairjs/ml/util.MLWriter} 
  109.      */
  110.     GBTRegressionModel.prototype.write = function() {
  111.        var javaObject =  this.getJavaObject().write();
  112.        return Utils.javaToJs(javaObject);
  113.     };
  114.     
  115.     //
  116.     // static methods
  117.     //
  118.     
  119.     
  120.     /**
  121.      * @returns {module:eclairjs/ml/util.MLReader} 
  122.      */
  123.     GBTRegressionModel.read = function() {
  124.        var javaObject =  org.apache.spark.ml.regression.GBTRegressionModel.read();
  125.        return Utils.javaToJs(javaObject);
  126.     };
  127.     
  128.     
  129.     /**
  130.      * @param {string} path
  131.      * @returns {module:eclairjs/ml/regression.GBTRegressionModel} 
  132.      */
  133.     GBTRegressionModel.load = function(path) {
  134.        var javaObject =  org.apache.spark.ml.regression.GBTRegressionModel.load(path);
  135.        return new GBTRegressionModel(javaObject);
  136.     };
  139.     module.exports = GBTRegressionModel;
  140. })();