Mila::Dnn::ComponentFactory Class Reference

Factory for reconstructing components from serialized archives. More...

Static Public Member Functions
template<DeviceType TDeviceType>
static std::shared_ptr< void >	createFromArchive (ModelArchive &archive, const std::string &component_name, std::shared_ptr< ExecutionContext< TDeviceType > > exec_context)
	Placeholder: create a component instance from archive.
static std::string	getComponentName (const SerializationMetadata &meta)
	Get component name from metadata.
static int64_t	getComponentVersion (const SerializationMetadata &meta)
	Get component version from metadata.
static std::string	getPrecision (const SerializationMetadata &meta)
	Get optional precision from metadata.
static ComponentType	parseComponentType (const SerializationMetadata &meta)
	Parse the built-in component kind from metadata.
static SerializationMetadata	readComponentMeta (ModelArchive &archive, const std::string &component_name)

Detailed Description

Factory for reconstructing components from serialized archives.

Provides type-safe helpers that read component metadata using SerializationMetadata abstraction, eliminating JSON exposure in component reconstruction code.

Design Pattern:

• Uses ModelArchive scoping API for organized access
• Abstracts serialization format via SerializationMetadata
• Provides extensible dispatch infrastructure for component types

Examples

/home/runner/work/Mila/Mila/Mila/Src/Dnn/Core/ComponentFactory.ixx.

Member Function Documentation

createFromArchive()

template<DeviceType TDeviceType>

std::shared_ptr< void > Mila::Dnn::ComponentFactory::createFromArchive ( ModelArchive & archive, const std::string & component_name, std::shared_ptr< ExecutionContext< TDeviceType > > exec_context )

inlinestatic

Placeholder: create a component instance from archive.

Full instantiation requires dispatching on both component kind and on-archive precision and is currently unimplemented. This method demonstrates the scoped read pattern and throws on invocation.

Implementation Strategy:

• Push scope "components/<name>"
• Read meta/config/tensors using relative paths
• Dispatch to the concrete Component<...>::fromArchive_ factory
• Return properly typed component instance

Parameters

archive	ModelArchive containing serialized component
component_name	Name of component to instantiate
exec_context	Execution context for the component

Returns

Shared pointer to component (placeholder type)

Exceptions

std::runtime_error

Always throws - dispatch not yet implemented

Note

Returning std::shared_ptr<void> is an intentional placeholder type – replace with the project's chosen type-erased component handle once the dispatch plumbing is implemented.

Future usage pattern:

auto component = ComponentFactory::createFromArchive<DeviceType::Cpu>(
    archive, "fc1", exec_context);

Examples

/home/runner/work/Mila/Mila/Mila/Src/Dnn/Core/ComponentFactory.ixx.

getComponentName()

std::string Mila::Dnn::ComponentFactory::getComponentName ( const SerializationMetadata & meta )

inlinestatic

Get component name from metadata.

Retrieves the component name field.

Parameters

meta	Component metadata

Returns

Component name

Exceptions

std::runtime_error

if name field is missing

Examples

/home/runner/work/Mila/Mila/Mila/Src/Dnn/Core/ComponentFactory.ixx.

getComponentVersion()

int64_t Mila::Dnn::ComponentFactory::getComponentVersion ( const SerializationMetadata & meta )

inlinestatic

Get component version from metadata.

Retrieves the component version field for compatibility checking during deserialization.

Parameters

meta	Component metadata

Returns

Version number

Exceptions

std::runtime_error

if version field is missing

Examples

/home/runner/work/Mila/Mila/Mila/Src/Dnn/Core/ComponentFactory.ixx.

getPrecision()

std::string Mila::Dnn::ComponentFactory::getPrecision ( const SerializationMetadata & meta )

inlinestatic

Get optional precision from metadata.

Retrieves the precision field if present, otherwise returns empty string.

Parameters

meta	Component metadata

Returns

Precision string or empty if not specified

Examples

/home/runner/work/Mila/Mila/Mila/Src/Dnn/Core/ComponentFactory.ixx.

parseComponentType()

ComponentType Mila::Dnn::ComponentFactory::parseComponentType ( const SerializationMetadata & meta )

inlinestatic

Parse the built-in component kind from metadata.

Convenience helper that looks up the "type" field in the component metadata and maps it to the typed ComponentType enum.

Parameters

meta	Component metadata

Returns

ComponentType enum value

Exceptions

std::runtime_error	if the metadata does not contain a "type" field
std::runtime_error	if the type string is not recognized

auto meta = readComponentMeta(archive, "fc1");
ComponentType type = parseComponentType(meta);
if (type == ComponentType::Linear) { ... }

Examples

/home/runner/work/Mila/Mila/Mila/Src/Dnn/Core/ComponentFactory.ixx.

---

The documentation for this class was generated from the following file:

• Mila/Src/Dnn/Core/ComponentFactory.ixx