sakura.sakuraAE.sakuraAE.insert_external_module

sakuraAE.insert_external_module(insert_config: dict, verbose=True)

Insert an external module and merge it with SAKURA model.

Parameters:
  • insert_config* – A configuration dictionary defining how to load and integrate the external module(s)

  • verbose (bool, optional) – Whether to enable verbose console logging, defaults to True

Note

Expected <insert_config> structure:

{
    'module_name': {
        "ext_model_config_path": (str) - Path to the external model's architecture config (JSON)
        "ext_signature_config_path": (str) - Path to the signature config (JSON)
        "ext_pheno_config_path": (str) - Path to the phenotype config (JSON)
        "ext_checkpoint_path": (str) - Path to the external model's checkpoint file
        "source": (str) -  Source component type in the external model (e.g., "decoder", "pheno_models", "signature_regressors")
        "source_name": (Optional[str]) - Name of the specific component (if applicable)
        "destination_type": (str) - Target component type in the current model  (e.g., "decoder", "pheno", "signature")
        "destination_name": (Optional[str]) - Name of the target component (if applicable)
    }
}
Returns:

None