ml.combust.bundle.dsl

Model

case class Model(op: String, attributes: Option[AttributeList] = scala.None) extends WritableModel with HasAttributeList[Model] with Product with Serializable

Class that encodes all information need to serialize or deserialize a machine learning model.

Models encode things like coefficients for linear regressions, labels for string indexers, sizes for one hot encoders, decision trees, and any other data needed to serialize and deserialize ML models and feature builders.

Usually you will want to pass ReadableModel or WritableModel to a user depending on the use case to constrict the allowed operations.

op

op name for the model

attributes

optional list of attributes for the model

Linear Supertypes
Serializable, Serializable, Product, Equals, HasAttributeList[Model], WritableModel, ReadableModel, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Model
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. HasAttributeList
  7. WritableModel
  8. ReadableModel
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Model(op: String, attributes: Option[AttributeList] = scala.None)

    op

    op name for the model

    attributes

    optional list of attributes for the model

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def attr(name: String): Attribute

    Get an attribute.

    Get an attribute.

    Throws an error if it does not exist.

    name

    name of the attribute

    returns

    the attribute

    Definition Classes
    HasAttributeList

  8. val attributes: Option[AttributeList]

    optional list of attributes for the model

    optional list of attributes for the model

    Definition Classes
    Model → HasAttributeList → ReadableModel

  9. def bundleModel(implicit context: SerializationContext): ModelDef

    Convert the Model to a protobuf serializable object.

    Convert the Model to a protobuf serializable object.

    context

    serialization context for encoding custom values

    returns

    protobuf model definition

    Definition Classes
    Model → ReadableModel

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  13. def getAttr(name: String): Option[Attribute]

    Get an attribute as an option.

    Get an attribute as an option.

    name

    name of the attribute

    returns

    Some(attribute) or None if it is not in the list

    Definition Classes
    HasAttributeList

  14. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  15. def getValue(name: String): Option[Value]

    Get the Value of an attribute as an Option.

    Get the Value of an attribute as an Option.

    name

    name of the attribute

    returns

    Value of the attribute as an Option[Value], None if it does not exist

    Definition Classes
    HasAttributeList

  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  20. val op: String

    op name for the model

    op name for the model

    Definition Classes
    Model → ReadableModel

  21. def replaceAttrList(list: AttributeList): Model

    Replace the attributes with another list.

    Replace the attributes with another list.

    list

    attributes to use to replace

    returns

    copy of T with attributes replaced by list arg

    Definition Classes
    Model → HasAttributeList → WritableModel

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  23. def value(name: String): Value

    Get the Value of an attribute.

    Get the Value of an attribute.

    Throws an error if that attribute does not exist.

    name

    name of the attribute

    returns

    Value of the attribute

    Definition Classes
    HasAttributeList

  24. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. def withAttr(attribute: Attribute): Model

    Add an attribute to the list.

    Add an attribute to the list.

    attribute

    attribute to add to the list

    returns

    a copy of T with the attribute added to the attribute list

    Definition Classes
    HasAttributeList

  28. def withAttrList(list: AttributeList): Model

    Add a list of attributes to attributes.

    Add a list of attributes to attributes.

    Adds all attributes in the list argument to attributes.

    list

    list of attributes to add

    returns

    copy of T with all attributes added to attributes

    Definition Classes
    HasAttributeList

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HasAttributeList[Model]

Inherited from WritableModel

Inherited from ReadableModel

Inherited from AnyRef

Inherited from Any

Ungrouped