serializer

Type Members

1. case class BundleContext(format: SerializationFormat, bundleRegistry: BundleRegistry, path: File) extends HasBundleRegistry with Product with Serializable

   

   Class for holding serialization information for a ml.combust.bundle.dsl.Bundle.

   Class for holding serialization information for a ml.combust.bundle.dsl.Bundle.

   This class holds all contextual information for serializing components into Bundle.ML.

   format

   desired serialization format (Json, Protobuf, or Mixed)

   bundleRegistry

   bundle registry of all supported operations

   path

   path to the Bundle.ML model

2. case class BundleRegistry() extends HasBundleRegistry with Product with Serializable

   

   Class for storing all supported ml.combust.bundle.op.OpNode and ml.combust.bundle.serializer.custom.CustomType objects.

   Class for storing all supported ml.combust.bundle.op.OpNode and ml.combust.bundle.serializer.custom.CustomType objects.

   This is the primary registry for Bundle.ML. It contains all objects required for serializing ML models, graph nodes and custom types.

   Many serialization calls in Bundle.ML require access to the registry for information on how to serialize custom types or models or nodes.

3. case class BundleSerializer(path: File)(implicit hr: HasBundleRegistry) extends Product with Serializable

   

   Class for serializing/deserializing Bundle.ML ml.combust.bundle.dsl.Bundle objects.

   Class for serializing/deserializing Bundle.ML ml.combust.bundle.dsl.Bundle objects.

   path

   path to the Bundle.ML folder to serialize/deserialize

   hr

   bundle registry for custom types and ops

4. sealed trait ConcreteSerializationFormat extends SerializationFormat with HasConcreteSerializationFormat

   

   Trait for defining the actual serialization format being used in a given context.

   Trait for defining the actual serialization format being used in a given context. This must be either JSON or Protobuf.

5. case class GraphSerializer(context: BundleContext) extends Product with Serializable

   

   Class for serializing a list of graph nodes.

   Class for serializing a list of graph nodes.

   context

   bundle context for encoding/decoding custom types, op nodes and op models

6. trait HasBundleRegistry extends AnyRef

   

   Trait for classes that contain a bundle registry.

   Trait for classes that contain a bundle registry.

   This is used by methods that require access to a bundle registry.

7. trait HasConcreteSerializationFormat extends AnyRef

   

   Trait inherited when a class has access to a concrete serialization format.

8. trait ModelDefSerializer extends AnyRef

   

   Trait for serializing a protobuf model definition.

9. case class ModelSerializer(context: BundleContext) extends Product with Serializable

   

   Class for serializing Bundle.ML models.

   Class for serializing Bundle.ML models.

   context

   bundle context for path and bundle registry

10. trait NodeDefSerializer extends AnyRef

    

    Trait for serializing node definitions.

11. case class NodeSerializer(context: BundleContext) extends Product with Serializable

    

    Class for serializing a Bundle.ML node.

    Class for serializing a Bundle.ML node.

    context

    bundle context for custom types and serialization formats

12. case class SerializationContext(concrete: ConcreteSerializationFormat, bundleRegistry: BundleRegistry) extends HasConcreteSerializationFormat with HasBundleRegistry with Product with Serializable

    

    Class for holding concrete serialization format and bundle registry.

    Class for holding concrete serialization format and bundle registry.

    This class is used by methods that need to know the exact serialization format being used as well as a bundle registry for all model, nodes and custom type type classes.

    concrete

    a concrete serialization format (JSON or Protobuf)

    bundleRegistry

    registry of custom types and ops

13. sealed trait SerializationFormat extends AnyRef

    

    Trait for defining which serialization format was used to write a Bundle.ML model.

    Trait for defining which serialization format was used to write a Bundle.ML model.

    Currently supported formats are:

    • mixed - use JSON for smaller attributes, models and nodes and protobuf for large attributes, models and nodes
    • json - used JSON for all attributes, models and nodes
    • protobuf - use protobuf for all attributes, models and nodes