ml.combust.bundle.dsl

WritableModel

trait WritableModel extends ReadableModel

Trait for a writable interface to a Model.

Use this trait during serialization of Model objects.

Linear Supertypes
ReadableModel, AnyRef, Any
Known Subclasses
Model
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. WritableModel
  2. ReadableModel
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def attr(name: String): Attribute

    Get a specific attribute by name.

    Get a specific attribute by name.

    Throws an error if the attribute does not exist.

    name

    name of the attribute

    returns

    the attribute

    Definition Classes
    ReadableModel

  2. abstract def attributes: Option[ReadableAttributeList]

    Get list of attributes for this model.

    Get list of attributes for this model.

    returns

    optional list read-only attribute list

    Definition Classes
    ReadableModel

  3. abstract 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
    ReadableModel

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

    Get an optional attribute by name.

    Get an optional attribute by name.

    name

    name of the attribute

    returns

    an optional attribute

    Definition Classes
    ReadableModel

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

    Get an optional value for an attribute.

    Get an optional value for an attribute.

    name

    name of the attribute

    returns

    optional value of the attribute

    Definition Classes
    ReadableModel

  6. abstract def op: String

    Get the op name for this model.

    Get the op name for this model.

    The op name defines what the model actually is. It corresponds to an entry for a ml.combust.bundle.op.OpNode in a ml.combust.bundle.serializer.BundleRegistry.

    ml.combust.bundle.op.OpModel have all methods and data needed to serialize a model for a given op name.

    Examples are "linear_regression", "string_indexer", "random_forest_classifier", etc.

    returns

    op name

    Definition Classes
    ReadableModel

  7. abstract def replaceAttrList(list: AttributeList): WritableModel

    Replace all attributes with another list.

    Replace all attributes with another list.

    list

    list of attributes used to replace existing attributes

    returns

    copy of model with attributes set to the given list

  8. abstract def value(name: String): Value

    Get the value of an attribute.

    Get the value of an attribute.

    Throws an error if the attribute does not exist.

    name

    name of the attribute

    returns

    value of the attribute

    Definition Classes
    ReadableModel

  9. abstract def withAttr(attribute: Attribute): WritableModel

    Add an attribute to the model.

    Add an attribute to the model.

    attribute

    attribute to add

    returns

    copy of the model with attribute appended

  10. abstract def withAttrList(list: AttributeList): WritableModel

    Add attributes from an attribute list to the model.

    Add attributes from an attribute list to the model.

    list

    list of attributes to add

    returns

    copy of the model with all attributes appended

Concrete 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 clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  18. def toString(): String

    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ReadableModel

Inherited from AnyRef

Inherited from Any

Ungrouped