Source: ml/Model.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 Transformer = require('./Transformer')();
  23.     /**
  24.      * @classdesc
  25.      * A fitted model, i.e., a {@link module:eclairjs/ml.Transformer} produced by an {@link module:eclairjs/ml.Estimator}.
  26.      *
  27.      * @class
  28.      * @memberof module:eclairjs/ml
  29.      * @extends module:eclairjs/ml.Transformer
  30.      */
  31.     function Model() {
  32.       Utils.handleAbstractConstructor(this, arguments);
  33.     }
  35.     Model.prototype = Object.create(Transformer.prototype);
  37.     Model.prototype.constructor = Model;
  39.     /**
  40.      * Sets the parent of this model.
  41.      * @param {module:eclairjs/ml.Estimator} parent
  42.      * @returns {object}
  43.      */
  44.     Model.prototype.setParent = function(parent) {
  45.       var args = {
  46.         target: this,
  47.         method: 'setParent',
  48.         args: Utils.wrapArguments(arguments),
  49.         returnType: Utils.getContextClass(this)
  50.       };
  52.       return Utils.generate(args);
  53.     };
  55.     /**
  56.      *
  57.      * @returns {module:eclairjs/ml.Estimator}
  58.      */
  59.     Model.prototype.parent = function() {
  60.       var Estimator = require('./Estimator')();
  62.       var args = {
  63.         target: this,
  64.         method: 'parent',
  65.         args: Utils.wrapArguments(arguments),
  66.         returnType: Estimator
  67.       };
  69.       return Utils.generate(args);
  70.     };
  72.     /**
  73.      *  Indicates whether this {@link Model} has a corresponding parent.
  74.      * @returns {Promise.<boolean>}
  75.      */
  76.     Model.prototype.hasParent = function() {
  77.       var args = {
  78.         target: this,
  79.         method: 'hasParent',
  80.         args: Utils.wrapArguments(arguments),
  81.         returnType: Boolean
  82.       };
  84.       return Utils.generate(args);
  85.     };
  87.     /**
  88.      * @param {module:eclairjs/ml/param.ParamMap} extra
  89.      * @returns {object}
  90.      */
  91.     Model.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.     return Model;
  103.   })();
  104. };