Type-safe metadata container for component serialization. More...

Public Member Functions
	SerializationMetadata ()=default
bool	empty () const noexcept
	Check if metadata is empty.
bool	getBool (const std::string &key) const
	Get boolean value.
double	getDouble (const std::string &key) const
	Get double value.
std::vector< double >	getDoubleVector (const std::string &key) const
	Get double vector value.
int64_t	getInt (const std::string &key) const
	Get integer value.
std::vector< int64_t >	getIntVector (const std::string &key) const
	Get integer vector value.
shape_t	getShape (const std::string &key) const
	Get shape value.
std::string	getString (const std::string &key) const
	Get string value.
std::vector< std::string >	getStringVector (const std::string &key) const
	Get string vector value.
bool	has (const std::string &key) const
	Check if key exists in metadata.
std::vector< std::string >	keys () const
	Get all keys in metadata.
SerializationMetadata &	set (const std::string &key, bool value)
	Set boolean value.
SerializationMetadata &	set (const std::string &key, const char *value)
	Set string value from C-string literal.
SerializationMetadata &	set (const std::string &key, const shape_t &value)
	Set shape value.
SerializationMetadata &	set (const std::string &key, const std::string &value)
	Set string value.
SerializationMetadata &	set (const std::string &key, const std::vector< double > &value)
	Set double vector value.
SerializationMetadata &	set (const std::string &key, const std::vector< std::string > &value)
	Set string vector value.
SerializationMetadata &	set (const std::string &key, double value)
	Set floating-point value (double).
SerializationMetadata &	set (const std::string &key, float value)
	Set floating-point value (float).
SerializationMetadata &	set (const std::string &key, int64_t value)
	Set integer value.
SerializationMetadata &	set (const std::string &key, MetadataValue value)
	Set metadata value with automatic type deduction.
size_t	size () const noexcept
	Get number of metadata entries.
json	toJson () const
	Convert to JSON representation (internal use only).
std::optional< bool >	tryGetBool (const std::string &key) const noexcept
	Get optional boolean value.
std::optional< double >	tryGetDouble (const std::string &key) const noexcept
	Get optional double value.
std::optional< float >	tryGetFloat (const std::string &key) const noexcept
	Get optional float value.
std::optional< int64_t >	tryGetInt (const std::string &key) const noexcept
	Get optional integer value.
std::optional< shape_t >	tryGetShape (const std::string &key) const noexcept
	Get optional shape value.
std::optional< std::string >	tryGetString (const std::string &key) const noexcept
	Get optional string value.

Static Public Member Functions
static SerializationMetadata	fromJson (const json &j)
	Construct from JSON representation (internal use only).

Private Member Functions
const MetadataValue &	getValue (const std::string &key) const

Private Attributes
std::map< std::string, MetadataValue >	data_

Detailed Description

Type-safe metadata container for component serialization.

Provides fluent API for building and reading component metadata without exposing JSON implementation details. Internally uses JSON for serialization but can be swapped with other formats without breaking user code.

Constructor & Destructor Documentation

◆ SerializationMetadata()

Mila::Dnn::Serialization::SerializationMetadata::SerializationMetadata ( )

default

Member Function Documentation

◆ empty()

bool Mila::Dnn::Serialization::SerializationMetadata::empty ( ) const

inlinenoexcept

Check if metadata is empty.

Returns: true if no metadata entries

◆ fromJson()

SerializationMetadata Mila::Dnn::Serialization::SerializationMetadata::fromJson ( const json & j )

inlinestatic

Construct from JSON representation (internal use only).

Used by ModelArchive to deserialize metadata. Not intended for direct user consumption.

Parameters

j	JSON object

Returns: SerializationMetadata instance

◆ getBool()

bool Mila::Dnn::Serialization::SerializationMetadata::getBool ( const std::string & key ) const

inline

Get boolean value.

Parameters

key	Metadata key

Returns: Boolean value

Exceptions

std::runtime_error if key not found or type mismatch

◆ getDouble()

double Mila::Dnn::Serialization::SerializationMetadata::getDouble ( const std::string & key ) const

inline

Get double value.

Parameters

key	Metadata key

Returns: Double value

Exceptions

std::runtime_error if key not found or type mismatch

◆ getDoubleVector()

std::vector< double > Mila::Dnn::Serialization::SerializationMetadata::getDoubleVector ( const std::string & key ) const

inline

Get double vector value.

Parameters

key	Metadata key

Returns: Double vector

Exceptions

std::runtime_error if key not found or type mismatch

◆ getInt()

int64_t Mila::Dnn::Serialization::SerializationMetadata::getInt ( const std::string & key ) const

inline

Get integer value.

Parameters

key	Metadata key

Returns: Integer value

Exceptions

std::runtime_error if key not found or type mismatch

◆ getIntVector()

std::vector< int64_t > Mila::Dnn::Serialization::SerializationMetadata::getIntVector ( const std::string & key ) const

inline

Get integer vector value.

Parameters

key	Metadata key

Returns: Integer vector

Exceptions

std::runtime_error if key not found or type mismatch

◆ getShape()

shape_t Mila::Dnn::Serialization::SerializationMetadata::getShape ( const std::string & key ) const

inline

Get shape value.

Constructs a TensorShape from the stored wire-format integer vector.

Parameters

key	Metadata key

Returns: shape_t value

Exceptions

std::runtime_error if key not found or type mismatch

◆ getString()

std::string Mila::Dnn::Serialization::SerializationMetadata::getString ( const std::string & key ) const

inline

Get string value.

Parameters

key	Metadata key

Returns: String value

Exceptions

std::runtime_error if key not found or type mismatch

◆ getStringVector()

std::vector< std::string > Mila::Dnn::Serialization::SerializationMetadata::getStringVector ( const std::string & key ) const

inline

Get string vector value.

Parameters

key	Metadata key

Returns: String vector

Exceptions

std::runtime_error if key not found or type mismatch

◆ getValue()

const MetadataValue & Mila::Dnn::Serialization::SerializationMetadata::getValue ( const std::string & key ) const

inlineprivate

◆ has()

bool Mila::Dnn::Serialization::SerializationMetadata::has ( const std::string & key ) const

inline

Check if key exists in metadata.

Parameters

key	Metadata key

Returns: true if key exists

◆ keys()

std::vector< std::string > Mila::Dnn::Serialization::SerializationMetadata::keys ( ) const

inline

Get all keys in metadata.

Returns: Vector of metadata keys

◆ set() [1/10]

SerializationMetadata & Mila::Dnn::Serialization::SerializationMetadata::set	(	const std::string &	key,
		bool	value )

inline

Set boolean value.

Parameters

key	Metadata key
value	Boolean value

Returns: Reference to this for method chaining

◆ set() [2/10]

SerializationMetadata & Mila::Dnn::Serialization::SerializationMetadata::set	(	const std::string &	key,
		const char *	value )

inline

Set string value from C-string literal.

Parameters

key	Metadata key
value	C-string value

Returns: Reference to this for method chaining

◆ set() [3/10]

SerializationMetadata & Mila::Dnn::Serialization::SerializationMetadata::set	(	const std::string &	key,
		const shape_t &	value )

inline

Set shape value.

Converts TensorShape to the wire format (std::vector<int64_t>) for JSON serialization. getShape() performs the inverse conversion on load.

Parameters

key	Metadata key
value	Shape value

Returns: Reference to this for method chaining

◆ set() [4/10]

SerializationMetadata & Mila::Dnn::Serialization::SerializationMetadata::set	(	const std::string &	key,
		const std::string &	value )

inline

Set string value.

Parameters

key	Metadata key
value	String value

Returns: Reference to this for method chaining

◆ set() [5/10]

SerializationMetadata & Mila::Dnn::Serialization::SerializationMetadata::set	(	const std::string &	key,
		const std::vector< double > &	value )

inline

Set double vector value.

Parameters

key	Metadata key
value	Double vector

Returns: Reference to this for method chaining

◆ set() [6/10]

SerializationMetadata & Mila::Dnn::Serialization::SerializationMetadata::set	(	const std::string &	key,
		const std::vector< std::string > &	value )

inline

Set string vector value.

Parameters

key	Metadata key
value	String vector

Returns: Reference to this for method chaining

◆ set() [7/10]

SerializationMetadata & Mila::Dnn::Serialization::SerializationMetadata::set	(	const std::string &	key,
		double	value )

inline

Set floating-point value (double).

Parameters

key	Metadata key
value	Double value

Returns: Reference to this for method chaining

◆ set() [8/10]

SerializationMetadata & Mila::Dnn::Serialization::SerializationMetadata::set	(	const std::string &	key,
		float	value )

inline

Set floating-point value (float).

Stores the float as double in the internal representation for consistent handling by the metadata container.

Parameters

key	Metadata key
value	Float value

Returns: Reference to this for method chaining

◆ set() [9/10]

SerializationMetadata & Mila::Dnn::Serialization::SerializationMetadata::set	(	const std::string &	key,
		int64_t	value )

inline

Set integer value.

Parameters

key	Metadata key
value	Integer value

Returns: Reference to this for method chaining

◆ set() [10/10]

SerializationMetadata & Mila::Dnn::Serialization::SerializationMetadata::set	(	const std::string &	key,
		MetadataValue	value )

inline

Set metadata value with automatic type deduction.

Parameters

key	Metadata key
value	Metadata value (string, int64_t, double, bool, vector, shape_t)

Returns: Reference to this for method chaining

◆ size()

size_t Mila::Dnn::Serialization::SerializationMetadata::size ( ) const

inlinenoexcept

Get number of metadata entries.

Returns: Entry count

◆ toJson()

json Mila::Dnn::Serialization::SerializationMetadata::toJson ( ) const

inline

Convert to JSON representation (internal use only).

Used by ModelArchive to serialize metadata. Not intended for direct user consumption.

Returns: JSON object

◆ tryGetBool()

std::optional< bool > Mila::Dnn::Serialization::SerializationMetadata::tryGetBool ( const std::string & key ) const

inlinenoexcept

Get optional boolean value.

Parameters

key	Metadata key

Returns: Boolean value or std::nullopt if not found or type mismatch

◆ tryGetDouble()

std::optional< double > Mila::Dnn::Serialization::SerializationMetadata::tryGetDouble ( const std::string & key ) const

inlinenoexcept

Get optional double value.

Parameters

key	Metadata key

Returns: Double value or std::nullopt if not found or type mismatch

◆ tryGetFloat()

std::optional< float > Mila::Dnn::Serialization::SerializationMetadata::tryGetFloat ( const std::string & key ) const

inlinenoexcept

Get optional float value.

Converts stored integer or double metadata to float when possible.

Parameters

key	Metadata key

Returns: Float value or std::nullopt if not found or type mismatch

◆ tryGetInt()

std::optional< int64_t > Mila::Dnn::Serialization::SerializationMetadata::tryGetInt ( const std::string & key ) const

inlinenoexcept

Get optional integer value.

Parameters

key	Metadata key

Returns: Integer value or std::nullopt if not found or type mismatch

◆ tryGetShape()

std::optional< shape_t > Mila::Dnn::Serialization::SerializationMetadata::tryGetShape ( const std::string & key ) const

inlinenoexcept

Get optional shape value.

Constructs a TensorShape from the stored wire-format integer vector.

Parameters

key	Metadata key

Returns: shape_t or std::nullopt if not found or type mismatch

◆ tryGetString()

std::optional< std::string > Mila::Dnn::Serialization::SerializationMetadata::tryGetString ( const std::string & key ) const

inlinenoexcept

Get optional string value.

Parameters

key	Metadata key

Returns: String value or std::nullopt if not found or type mismatch

Member Data Documentation

◆ data_

std::map<std::string, MetadataValue> Mila::Dnn::Serialization::SerializationMetadata::data_

private

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

/__w/Mila/Mila/Mila/Src/Dnn/Serialization/SerializationMetadata.ixx

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SerializationMetadata()

Member Function Documentation

◆ empty()

◆ fromJson()

◆ getBool()

◆ getDouble()

◆ getDoubleVector()

◆ getInt()

◆ getIntVector()

◆ getShape()

◆ getString()

◆ getStringVector()

◆ getValue()

◆ has()

◆ keys()

◆ set() [1/10]

◆ set() [2/10]

◆ set() [3/10]

◆ set() [4/10]

◆ set() [5/10]

◆ set() [6/10]

◆ set() [7/10]

◆ set() [8/10]

◆ set() [9/10]

◆ set() [10/10]

◆ size()

◆ toJson()

◆ tryGetBool()

◆ tryGetDouble()

◆ tryGetFloat()

◆ tryGetInt()

◆ tryGetShape()

◆ tryGetString()

Member Data Documentation

◆ data_