com.tencent.angel.sona.ml.param.AngelDataParams.scala Maven / Gradle / Ivy

Go to download
/*
 * Tencent is pleased to support the open source community by making Angel available.
 *
 * Copyright (C) 2017-2018 THL A29 Limited, a Tencent company. All rights reserved.
 *
 * 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
 *
 * https://opensource.org/licenses/Apache-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 com.tencent.angel.sona.ml.param
import com.tencent.angel.mlcore.conf.MLCoreConf
import com.tencent.angel.sona.ml.param.shared.{HasNumFeatures, HasWeightCol}


trait AngelDataParams extends Params with HasNumFeatures with HasModelSize with HasNumField
  with HasSparseData with HasWeightCol with ParamsHelper {

  def setNumFeatures(value: Long): this.type = setInternal(numFeature, value)

  setDefault(numFeature -> MLCoreConf.DEFAULT_ML_FEATURE_INDEX_RANGE)

  def setModelSize(value:Long): this.type = setInternal(modelSize, value)

  setDefault(modelSize -> MLCoreConf.DEFAULT_ML_MODEL_SIZE)

  def setNumField(value: Int): this.type = setInternal(numField, value)

  setDefault(numField -> MLCoreConf.DEFAULT_ML_FIELD_NUM)

  def setIsSparse(value: Boolean): this.type = setInternal(isSparse, value)

  setDefault(isSparse -> true)
}

trait HasNumField extends Params {
  final val numField: IntParam = new IntParam(this, "numField",
    "the number of field of each instance (> 0)", (value: Int) => value == -1 || value > 0)

  final def getNumField: Int = $(numField)
}


trait HasModelSize extends Params {
  final val modelSize: LongParam = new LongParam(this, "modelSize",
    "the model size must (> 0)", (value: Long) => value == -1 || value > 0)

  final def getModelSize: Long = $(modelSize)
}

trait HasNumClasses extends Params {
  final val numClass: IntParam = new IntParam(this, "numClasses",
    "the number of classes (> 0)", ParamValidators.gt(0))

  final def getNumClass: Int = $(numClass)
}


trait HasSparseData extends Params {
  final val isSparse: BooleanParam = new BooleanParam(this, "isSparse",
    "is the input data sparse ?")

  final def getIsSparse: Boolean = $(isSparse)
}