Packages

t

org.apache.spark.ml.util

MLFormatRegister

trait MLFormatRegister extends MLWriterFormat

ML export formats for should implement this trait so that users can specify a shortname rather than the fully qualified class name of the exporter.

A new instance of this class will be instantiated each time a save call is made.

Annotations
@Unstable() @Since( "2.4.0" )
Since

2.4.0

Linear Supertypes
MLWriterFormat, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MLFormatRegister
  2. MLWriterFormat
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def format(): String

    The string that represents the format that this format provider uses.

    The string that represents the format that this format provider uses. This is, along with stageName, is overridden by children to provide a nice alias for the writer. For example:

    override def format(): String =
        "pmml"

    Indicates that this format is capable of saving a pmml model.

    Must have a valid zero argument constructor which will be called to instantiate.

    Format discovery is done using a ServiceLoader so make sure to list your format in META-INF/services.

    Annotations
    @Since( "2.4.0" )
    Since

    2.4.0

  2. abstract def stageName(): String

    The string that represents the stage type that this writer supports.

    The string that represents the stage type that this writer supports. This is, along with format, is overridden by children to provide a nice alias for the writer. For example:

    override def stageName(): String =
        "org.apache.spark.ml.regression.LinearRegressionModel"

    Indicates that this format is capable of saving Spark's own PMML model.

    Format discovery is done using a ServiceLoader so make sure to list your format in META-INF/services.

    Annotations
    @Since( "2.4.0" )
    Since

    2.4.0

  3. abstract def write(path: String, session: SparkSession, optionMap: Map[String, String], stage: PipelineStage): Unit

    Function to write the provided pipeline stage out.

    Function to write the provided pipeline stage out.

    path

    The path to write the result out to.

    session

    SparkSession associated with the write request.

    optionMap

    User provided options stored as strings.

    stage

    The pipeline stage to be saved.

    Definition Classes
    MLWriterFormat
    Annotations
    @Since( "2.4.0" )

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from MLWriterFormat

Inherited from AnyRef

Inherited from Any

Members