com.alpine.model.MLModel.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of alpine-model-api Show documentation
alpine-model-api
There is a newer version: 1.11
/*
 * Copyright (c) 2015 Alpine Data Labs
 * All rights reserved.
 */
package com.alpine.model

import com.alpine.features.FeatureDesc
import com.alpine.metadata.DetailedTransformationSchema
import com.alpine.result._
import com.alpine.transformer._
import com.alpine.util.FeatureUtil

/**
 * These objects are serialized to JSON via GSON, augmented with type adapters for known interfaces,
 * scala Seq collections and Options.
 */

trait MLModel extends Serializable {
  /**
   * This should return a representative class from every jar that is needed to load
   * the object during deserialization.
   *
   * Default implementation returns the class of MLModel,
   * and the class of the model implementation.
   */
  def classesForLoading: Set[Class[_]] = Set[Class[_]](classOf[MLModel], this.getClass)
}

/**
 * RowModels are models that will produce a single result per row of data.
 */
trait RowModel extends MLModel {
  def transformer: Transformer
  def inputFeatures: Seq[FeatureDesc[_]]
  def outputFeatures: Seq[FeatureDesc[_]]
  /**
   * Used to identify this model when in a collection of models.
   * Should be simple characters, so it can be used in a feature name.
   * @return identifier for the model.
   */
  def identifier: String = ""
  def transformationSchema: DetailedTransformationSchema = {
    DetailedTransformationSchema(inputFeatures, outputFeatures, identifier)
  }
}

/**
 * A model that predicts values in a predefined set of classes.
 */
trait CategoricalRowModel extends RowModel {
  /**
   * The total set of classes that the predicted value can take on.
   * @return The set of possible values for the predicted value.
   */
  def classLabels: Seq[String]
  def transformer: CategoricalTransformer[_ <: CategoricalResult]
}

trait ClassificationRowModel extends CategoricalRowModel {
  def transformer: CategoricalTransformer[_ <: ClassificationResult]
  def outputFeatures = FeatureUtil.classificationOutputFeatures
  /**
   * Used when we are doing model quality evaluation e.g. Confusion Matrix,
   * so we know what feature in the test dataset to compare the result to.
   * @return Feature description used to identify the dependent feature in an evaluation dataset.
   */
  def dependentFeature: FeatureDesc[_]
}

trait ClusteringRowModel extends CategoricalRowModel {
  def transformer: CategoricalTransformer[_ <: ClusteringResult]
  def outputFeatures = FeatureUtil.clusteringOutputFeatures
}

trait RegressionRowModel extends RowModel {
  def transformer: RegressionTransformer
  def outputFeatures = FeatureUtil.regressionOutputFeatures
  /**
   * Used when we are doing model quality evaluation e.g. Confusion Matrix,
   * so we know what feature in the test dataset to compare the result to.
   * @return Feature description used to identify the dependent feature in an evaluation dataset.
   */
  def dependentFeature: FeatureDesc[_]
}