ai.h2o.sparkling.ml.params.NullableMatrixArrayParam.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sparkling-water-ml_2.12 Show documentation
Sparkling Water ML Pipelines
The newest version!
/*
 * 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 ai.h2o.sparkling.ml.params

import org.apache.spark.ml.linalg.DenseMatrix
import org.apache.spark.ml.param.{Param, ParamPair, Params}
import org.json4s.JsonAST._
import org.json4s.jackson.JsonMethods.{compact, parse, render}

import scala.collection.JavaConverters._

class NullableMatrixArrayParam(parent: Params, name: String, doc: String, isValid: Array[DenseMatrix] => Boolean)
  extends Param[Array[DenseMatrix]](parent, name, doc, isValid) {

  def this(parent: Params, name: String, doc: String) =
    this(parent, name, doc, _ => true)

  /** Creates a param pair with a `java.util.List` of values (for Java and Python). */
  def w(value: java.util.List[DenseMatrix]): ParamPair[Array[DenseMatrix]] = w(value.asScala.toArray)

  override def jsonEncode(value: Array[DenseMatrix]): String = {
    val ast = if (value == null) {
      JNull
    } else {
      val matrixObjects = value.map { matrix =>
        val numRows = JField("numRows", JInt(matrix.numRows))
        val numCols = JField("numCols", JInt(matrix.numRows))
        val valueArray = JArray(matrix.values.map(DoubleParam.jValueEncode).toList)
        val values = JField("values", valueArray)
        val transposed = JField("transposed", JBool(matrix.isTransposed))
        JObject(numRows, numCols, values, transposed)
      }.toList
      JArray(matrixObjects)
    }
    compact(render(ast))
  }

  override def jsonDecode(json: String): Array[DenseMatrix] = {
    parse(json) match {
      case JNull =>
        null
      case JArray(matrices) =>
        matrices.map {
          case JObject(
              List(
                JField("numRows", JInt(numRows)),
                JField("numCols", JInt(numCols)),
                JField("values", JArray(valueArray)),
                JField("transposed", JBool(transposed)))) =>
            val values = valueArray.map(DoubleParam.jValueDecode).toArray
            new DenseMatrix(numRows.toInt, numCols.toInt, values, transposed)
          case _ =>
            throw new IllegalArgumentException(s"Cannot decode $json to DenseMatrix.")
        }.toArray
      case _ =>
        throw new IllegalArgumentException(s"Cannot decode $json to Array[DenseMatrix].")
    }
  }
}