io.radicalbit.flink.pmml.scala.models.prediction.Prediction.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-jpmml-scala_2.10 Show documentation
flink-jpmml-scala
The newest version!
/*
 * Copyright (C) 2017  Radicalbit
 *
 * This file is part of flink-JPMML
 *
 * flink-JPMML is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * flink-JPMML is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with flink-JPMML.  If not, see .
 */

package io.radicalbit.flink.pmml.scala.models.prediction

import io.radicalbit.flink.pmml.scala.api.exceptions._
import io.radicalbit.flink.pmml.scala.logging.LazyLogging
import org.jpmml.evaluator.EvaluationException

import scala.util.control.NonFatal
import scala.util.{Failure, Success, Try}

/** Factory for [[Prediction]] case class instances */
object Prediction extends LazyLogging {

  /** Evaluates [[Try]] statement executed at [[io.radicalbit.flink.pmml.scala.api.PmmlModel.predict]]
    *
    * @param out containing evaluation pipeline execution
    * @return
    */
  private[scala] def extractPrediction(out: Try[Double]): Prediction = out match {
    case Success(result) => Prediction(Score(result))
    case Failure(throwable) => onFailedPrediction(throwable)
  }

  /** Pattern matches failures arisen by [[io.radicalbit.flink.pmml.scala.api.PmmlModel.predict]]
    *
    * @param throwable
    * @return
    */
  private[scala] def onFailedPrediction(throwable: Throwable): Prediction = {

    throwable match {
      case e: JPMMLExtractionException =>
        logger.warn("Error while extracting results", e.getMessage)
      case e: InputPreparationException =>
        logger.warn("Error while preparing input", e.getMessage)
      case e: InputValidationException => logger.warn("Error while validate input", e.getMessage)
      case e: EvaluationException => logger.warn("Error while evaluate model", e.getMessage)
      case e: ClassCastException => logger.error("Error while extract target", e)
      case NonFatal(e) => logger.error("Error", e)
    }

    emptyTarget

  }

  private val emptyTarget = Prediction(EmptyScore)

}

/** Models the result output container
  *
  * @param value contains the extracted prediction of [[Target]] type
  */
case class Prediction(value: Target)