Package org.apache.spark.ml.util

Interface MLFormatRegister

All Superinterfaces:

MLWriterFormat

All Known Implementing Classes:

InternalKMeansModelWriter, InternalLinearRegressionModelWriter, PMMLKMeansModelWriter, PMMLLinearRegressionModelWriter

public interface 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.

Since:

2.4.0

Method Summary

Modifier and Type	Method	Description
String	format()	The string that represents the format that this format provider uses.
String	shortName()
String	stageName()	The string that represents the stage type that this writer supports.

Methods inherited from interface org.apache.spark.ml.util.MLWriterFormat

write

Method Details

format

String format()

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.

Returns:

(undocumented)

Since:

2.4.0

shortName

String shortName()

stageName

String stageName()

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.

Returns:

(undocumented)

Since:

2.4.0