org.apache.lens.ml.algo.api.MLAlgo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lens-ml-lib Show documentation

Lens ML Lib

There is a newer version: 2.7.1

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.lens.ml.algo.api;

import org.apache.lens.api.LensConf;
import org.apache.lens.api.LensException;

/**
 * The Interface MLAlgo.
 */
public interface MLAlgo {
  String getName();

  String getDescription();

  /**
   * Configure.
   *
   * @param configuration the configuration
   */
  void configure(LensConf configuration);

  LensConf getConf();

  /**
   * Train.
   *
   * @param conf    the conf
   * @param db      the db
   * @param table   the table
   * @param modelId the model id
   * @param params  the params
   * @return the ML model
   * @throws LensException the lens exception
   */
  MLModel train(LensConf conf, String db, String table, String modelId, String... params) throws LensException;
}