Class

ml.combust.bundle.dsl

Model

Related Doc: package dsl

Permalink

case class Model(op: String, attributes: Option[AttributeList] = 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
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

    op

    op name for the model

    attributes

    optional list of attributes for the model

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def attr(name: String): Attribute

    Permalink

    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

  6. val attributes: Option[AttributeList]

    Permalink

    optional list of attributes for the model

    optional list of attributes for the model

    Definition Classes
    Model → HasAttributeList → ReadableModel

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

    Permalink

    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

  8. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  10. def finalize(): Unit

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

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

    Permalink

    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

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

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink

    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

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. val op: String

    Permalink

    op name for the model

    op name for the model

    Definition Classes
    Model → ReadableModel

  19. def replaceAttrList(list: AttributeList): Model

    Permalink

    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

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

    Permalink
    Definition Classes
    AnyRef

  21. def value(name: String): Value

    Permalink

    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

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. def withAttr(attribute: Attribute): Model

    Permalink

    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

  26. def withAttrList(list: AttributeList): Model

    Permalink

    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