Trait

ml.combust.bundle.dsl

ReadableModel

Related Doc: package dsl

Permalink

trait ReadableModel extends AnyRef

Trait for read-only operations on a Model.

Use this trait to expose a read-only interface to a Model. This is primarily used when deserializing.

Linear Supertypes
AnyRef, Any
Known Subclasses
Model, WritableModel
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReadableModel
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

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

    Permalink

    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

  2. abstract def attributes: Option[ReadableAttributeList]

    Permalink

    Get list of attributes for this model.

    Get list of attributes for this model.

    returns

    optional list read-only attribute list

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

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

    Permalink

    Get an optional attribute by name.

    Get an optional attribute by name.

    name

    name of the attribute

    returns

    an optional attribute

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

    Permalink

    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

  6. abstract def op: String

    Permalink

    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

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

    Permalink

    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

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

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

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

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped