core/src/main/scala/io/prediction/core/BaseAlgorithm.scala

/** Copyright 2015 TappingStone, Inc.
  *
  * Licensed 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 io.prediction.core

import io.prediction.controller.Utils
import io.prediction.controller.Params

import org.apache.spark.SparkContext
import org.apache.spark.SparkContext._
import org.apache.spark.rdd.RDD
import scala.reflect._

trait WithBaseQuerySerializer {
  @transient lazy val querySerializer = Utils.json4sDefaultFormats
}

abstract class BaseAlgorithm[PD, M, Q : Manifest, P]
  extends AbstractDoer with WithBaseQuerySerializer {
  def trainBase(sc: SparkContext, pd: PD): M

  // Used by Evaluation
  def batchPredictBase(sc: SparkContext, bm: Any, qs: RDD[(Long, Q)])
  : RDD[(Long, P)]

  // Used by Deploy
  def predictBase(bm: Any, q: Q): P

  def queryManifest(): Manifest[Q] = manifest[Q]
  
  def makePersistentModel(sc: SparkContext, modelId: String, 
    algoParams: Params, bm: Any)
  : Any = Unit

  // TODO(yipjustin): obsolete as of 0.8.7. cleanup.
  def isJava: Boolean
  def isParallel: Boolean = true
}