Source: ml/Predictor.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. module.exports = function(kernelP) {
  18.   return (function() {
  19.     var Utils = require('../utils.js');
  21.     var Estimator = require('./Estimator')();
  23.     /**
  24.      * @classdesc
  25.      * Abstraction for prediction problems (regression and classification).
  26.      *
  27.      *                       E.g., {@link VectorUDT} for vector features.
  28.      *                  parameter to specify the concrete type.
  29.      *            parameter to specify the concrete type for the corresponding model.
  30.      * @class
  31.      * @memberof module:eclairjs/ml
  32.      * @extends module:eclairjs/ml.Estimator
  33.      */
  34.     function Predictor() {
  35.       Utils.handleAbstractConstructor(this, arguments);
  36.     }
  38.     Predictor.prototype = Object.create(Estimator.prototype);
  40.     Predictor.prototype.constructor = Predictor;
  42.     /**
  43.      * @param {string} value
  44.      * @returns {module:eclairjs/ml.Predictor}
  45.      */
  46.     Predictor.prototype.setLabelCol = function(value) {
  47.       var args = {
  48.         target: this,
  49.         method: 'setLabelCol',
  50.         args: Utils.wrapArguments(arguments),
  51.         returnType: Utils.getContextClass(this)
  52.       };
  54.       return Utils.generate(args);
  55.     };
  57.     /**
  58.      * @param {string} value
  59.      * @returns {module:eclairjs/ml.Predictor}
  60.      */
  61.     Predictor.prototype.setFeaturesCol = function(value) {
  62.       var args = {
  63.         target: this,
  64.         method: 'setFeaturesCol',
  65.         args: Utils.wrapArguments(arguments),
  66.         returnType: Utils.getContextClass(this)
  67.       };
  69.       return Utils.generate(args);
  70.     };
  72.     /**
  73.      * @param {string} value
  74.      * @returns {module:eclairjs/ml.Predictor}
  75.      */
  76.     Predictor.prototype.setPredictionCol = function(value) {
  77.       var args = {
  78.         target: this,
  79.         method: 'setPredictionCol',
  80.         args: Utils.wrapArguments(arguments),
  81.         returnType: Utils.getContextClass(this)
  82.       };
  84.       return Utils.generate(args);
  85.     };
  87.     /**
  88.      * @param {module:eclairjs/ml/param.ParamMap} extra
  89.      * @returns {module:eclairjs/ml.Predictor}
  90.      */
  91.     Predictor.prototype.copy = function(extra) {
  92.       var args = {
  93.         target: this,
  94.         method: 'copy',
  95.         args: Utils.wrapArguments(arguments),
  96.         returnType: Utils.getContextClass(this)
  97.       };
  99.       return Utils.generate(args);
  100.     };
  102.     /**
  103.      * @param {module:eclairjs/sql/types.StructType} schema
  104.      * @returns {module:eclairjs/sql/types.StructType}
  105.      */
  106.     Predictor.prototype.transformSchema = function(schema) {
  107.       var StructType = require('../sql/types/StructType.js')();
  109.       var args = {
  110.         target: this,
  111.         method: 'transformSchema',
  112.         args: Utils.wrapArguments(arguments),
  113.         returnType: StructType
  114.       };
  116.       return Utils.generate(args);
  117.     };
  119.     return Predictor;
  120.   })();
  121. };