Mila::Dnn::ComponentConfig Class Reference

Abstract base for component configuration objects. More...

Inheritance diagram for Mila::Dnn::ComponentConfig:

Public Member Functions
virtual	~ComponentConfig ()=default
	Virtual destructor for polymorphic base.
virtual void	fromMetadata (const SerializationMetadata &meta)=0
	Populate configuration from provided metadata.
virtual SerializationMetadata	toMetadata () const =0
	Convert configuration into a SerializationMetadata object.
virtual std::string	toString () const =0
	Produce a short, human-readable summary of the configuration.
virtual void	validate () const =0
	Validate configuration parameters.

Detailed Description

Abstract base for component configuration objects.

ComponentConfig defines the public API common to all configuration objects:

• serialization to/from the framework's metadata abstraction
• configuration validation
• a compact string summary

Implementations are expected to override the pure-virtual members and include base-field handling (precision_) when appropriate.

Constructor & Destructor Documentation

~ComponentConfig()

virtual Mila::Dnn::ComponentConfig::~ComponentConfig ( )

virtualdefault

Virtual destructor for polymorphic base.

Member Function Documentation

fromMetadata()

virtual void Mila::Dnn::ComponentConfig::fromMetadata ( const SerializationMetadata & meta )

pure virtual

Populate configuration from provided metadata.

Implementations should read available keys and leave missing keys at their current/default values to preserve forward/backward compatibility.

Parameters

meta	Metadata to read configuration values from.

Implemented in Mila::Dnn::CrossEntropyConfig, Mila::Dnn::GeluConfig, Mila::Dnn::GptBlockConfig, Mila::Dnn::GptConfig, Mila::Dnn::GqaConfig, Mila::Dnn::LayerNormConfig, Mila::Dnn::LinearConfig, Mila::Dnn::LlamaConfig, Mila::Dnn::LpeConfig, Mila::Dnn::MLPConfig, Mila::Dnn::MultiHeadAttentionConfig, Mila::Dnn::Optimizers::AdamWConfig, Mila::Dnn::ResidualConfig, Mila::Dnn::RmsNormConfig, Mila::Dnn::RopeConfig, Mila::Dnn::SoftmaxConfig, Mila::Dnn::SwigluConfig, and Mila::Dnn::TokenEmbeddingConfig.

toMetadata()

virtual SerializationMetadata Mila::Dnn::ComponentConfig::toMetadata ( ) const

pure virtual

Convert configuration into a SerializationMetadata object.

Implementations should include any fields required to fully reconstruct the configuration via fromMetadata.

Returns

SerializationMetadata Metadata representation of the config.

Implemented in Mila::Dnn::CrossEntropyConfig, Mila::Dnn::GeluConfig, Mila::Dnn::GptBlockConfig, Mila::Dnn::GptConfig, Mila::Dnn::GqaConfig, Mila::Dnn::LayerNormConfig, Mila::Dnn::LinearConfig, Mila::Dnn::LlamaConfig, Mila::Dnn::LpeConfig, Mila::Dnn::MLPConfig, Mila::Dnn::MultiHeadAttentionConfig, Mila::Dnn::Optimizers::AdamWConfig, Mila::Dnn::ResidualConfig, Mila::Dnn::RmsNormConfig, Mila::Dnn::RopeConfig, Mila::Dnn::SoftmaxConfig, Mila::Dnn::SwigluConfig, and Mila::Dnn::TokenEmbeddingConfig.

toString()

virtual std::string Mila::Dnn::ComponentConfig::toString ( ) const

pure virtual

Produce a short, human-readable summary of the configuration.

Implementations should return a compact, single-line description suitable for logging and debugging.

Returns

std::string Human-readable summary of the configuration.

Implemented in Mila::Dnn::CrossEntropyConfig, Mila::Dnn::GeluConfig, Mila::Dnn::GptBlockConfig, Mila::Dnn::GptConfig, Mila::Dnn::GqaConfig, Mila::Dnn::LayerNormConfig, Mila::Dnn::LinearConfig, Mila::Dnn::LlamaConfig, Mila::Dnn::LpeConfig, Mila::Dnn::MLPConfig, Mila::Dnn::MultiHeadAttentionConfig, Mila::Dnn::Optimizers::AdamWConfig, Mila::Dnn::ResidualConfig, Mila::Dnn::RmsNormConfig, Mila::Dnn::RopeConfig, Mila::Dnn::SoftmaxConfig, Mila::Dnn::SwigluConfig, and Mila::Dnn::TokenEmbeddingConfig.

validate()

virtual void Mila::Dnn::ComponentConfig::validate ( ) const

pure virtual

Validate configuration parameters.

Called by callers to ensure the configuration represents a valid, constructible component. Implementations must throw std::invalid_argument (or a derived exception) when validation fails.

Exceptions

std::invalid_argument

If the configuration is invalid.

Implemented in Mila::Dnn::CrossEntropyConfig, Mila::Dnn::DropoutConfig, Mila::Dnn::GeluConfig, Mila::Dnn::GptBlockConfig, Mila::Dnn::GptConfig, Mila::Dnn::GqaConfig, Mila::Dnn::LayerNormConfig, Mila::Dnn::LinearConfig, Mila::Dnn::LlamaConfig, Mila::Dnn::LpeConfig, Mila::Dnn::MLPConfig, Mila::Dnn::MultiHeadAttentionConfig, Mila::Dnn::Optimizers::AdamWConfig, Mila::Dnn::ResidualConfig, Mila::Dnn::RmsNormConfig, Mila::Dnn::RopeConfig, Mila::Dnn::SoftmaxConfig, Mila::Dnn::SwigluConfig, and Mila::Dnn::TokenEmbeddingConfig.

---

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

• /__w/Mila/Mila/Mila/Src/Dnn/Core/ComponentConfig.ixx