ml.combust.bundle.dsl

Bundle

case class Bundle(name: String, format: SerializationFormat, version: String, attributes: Option[AttributeList], nodes: Seq[Any]) extends HasAttributeList[Bundle] with Product with Serializable

Root object for serializing Bundle.ML pipelines and graphs.

name

name of the bundle

format

serialization format of the Bundle

version

Bundle.ML version used for serializing

attributes

optional AttributeList to serialize with the bundle

nodes

list of root nodes in the bundle

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

Instance Constructors

  1. new Bundle(name: String, format: SerializationFormat, version: String, attributes: Option[AttributeList], nodes: Seq[Any])

    name

    name of the bundle

    format

    serialization format of the Bundle

    version

    Bundle.ML version used for serializing

    attributes

    optional AttributeList to serialize with the bundle

    nodes

    list of root nodes in the bundle

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 AttributeList to serialize with the bundle

    optional AttributeList to serialize with the bundle

    Definition Classes
    BundleHasAttributeList
  9. def bundleContext(bundleRegistry: BundleRegistry, path: File): BundleContext

    Create a ml.combust.bundle.serializer.BundleContext for serializing to Bundle.

    Create a ml.combust.bundle.serializer.BundleContext for serializing to Bundle.ML

    bundleRegistry

    bundle registry for serializing ops, nodes, and custom types

    path

    path to the Bundle.ML directory

    returns

    context for serializing Bundle.ML

  10. def bundleDef(context: BundleContext)(implicit sc: SerializationContext): BundleDef

    Convert to protobuf bundle definition.

    Convert to protobuf bundle definition.

    context

    bundle context for serialization format

    sc

    serialization context for decoding custom values

    returns

    protobuf bundle definition

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  13. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. val format: SerializationFormat

    serialization format of the Bundle

  15. 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
  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  17. 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
  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  19. val name: String

    name of the bundle

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

    Definition Classes
    AnyRef
  21. val nodes: Seq[Any]

    list of root nodes in the bundle

  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. def replaceAttrList(list: AttributeList): Bundle

    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
    BundleHasAttributeList
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  26. 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
  27. val version: String

    Bundle.

    Bundle.ML version used for serializing

  28. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def withAttr(attribute: Attribute): Bundle

    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
  32. def withAttrList(list: AttributeList): Bundle

    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[Bundle]

Inherited from AnyRef

Inherited from Any

Ungrouped