Source: ml/util/MLWriter.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. */
  18. var Utils = require('../../utils.js');
  21. /**
  22.  * @classdesc
  23.  * :: Experimental ::
  24.  *
  25.  * Abstract class for utility classes that can save ML instances.
  26.  * @class
  27.  * @memberof module:eclairjs/ml/util
  28.  */
  30. /**
  31.  * @returns {Promise.<Void>} A Promise that resolves to nothing.
  32.  * @constructor
  33.  */
  34. function MLWriter(kernelP, refIdP) {
  35. 	 throw "Can't instantiate abstract class - MLWriter";
  36. }
  40. /**
  41.  * Saves the ML instances to the input path.
  42.  * @param {string} path
  43.  * @returns {Promise.<Void>} A Promise that resolves to nothing.
  44.  */
  45. MLWriter.prototype.save = function(path) {
  46.   var args ={
  47.     target: this,
  48.     method: 'save',
  49.     args: Utils.wrapArguments(arguments),
  50.     returnType: null
  52.   };
  54.   return Utils.generate(args);
  55. };
  58. /**
  59.  * Overwrites if the output path already exists.
  60.  * @returns {MLWriter}
  61.  */
  62. MLWriter.prototype.overwrite = function() {
  63.   var args ={
  64.     target: this,
  65.     method: 'overwrite',
  66.     returnType: MLWriter
  68.   };
  70.   return Utils.generate(args);
  71. };
  74. /**
  75.  * @param {module:eclairjs/sql.SparkSession} sparkSession
  76.  * @returns {MLWriter}
  77.  */
  78. MLWriter.prototype.session = function(sparkSession) {
  79.   var args ={
  80.     target: this,
  81.     method: 'session',
  82.     args: Utils.wrapArguments(arguments),
  83.     returnType: MLWriter
  85.   };
  87.   return Utils.generate(args);
  88. };
  91. /**
  92.  * @param {module:eclairjs/sql.SQLContext} sqlContext
  93.  * @returns {MLWriter}
  94.  */
  95. MLWriter.prototype.context = function(sqlContext) {
  96.   var args ={
  97.     target: this,
  98.     method: 'context',
  99.     args: Utils.wrapArguments(arguments),
  100.     returnType: MLWriter
  102.   };
  104.   return Utils.generate(args);
  105. };
  107. module.exports = MLWriter;