如何在Python中将wandb对象传递至其他文件的类？

解决方案 #

有两种常用方式可实现WandB对象跨文件传递，解决日志无法记录的问题：

1. 显式通过类构造函数传递

这是最直观可控的方式，将初始化好的WandB run对象传入目标类的构造函数，保存为类实例变量后使用：

其他文件（如trainer.py）的类定义：

# trainer.py
class ModelTrainer:
    def __init__(self, wandb_run):
        self.wandb_run = wandb_run  # 保存传入的WandB run对象

    def log_training_metrics(self, metrics, step):
        # 使用保存的对象记录日志
        self.wandb_run.log(metrics, step=step)

main.py中的调用代码：

# main.py
import wandb
from trainer import ModelTrainer

exp_name = "experiment name"
run = wandb.init(config=wandb.config, project=exp_name, entity="username")

# 将run对象传入类实例
trainer = ModelTrainer(wandb_run=run)

# 训练过程中调用日志方法
trainer.log_training_metrics({'Accuracy/train': 100.0 * n_class_corrected / total_class_samples}, step=iteration)

2. 利用WandB全局run对象

WandB初始化后，会在全局维护一个wandb.run对象，其他文件无需显式传递，直接调用即可：

其他文件的类定义：

# trainer.py
import wandb

class ModelTrainer:
    def log_training_metrics(self, metrics, step):
        # 直接使用全局的wandb.run对象记录日志
        wandb.run.log(metrics, step=step)

这种方式无需传递参数，适合单run场景，代码更简洁。

关键注意事项 #

• 必须先初始化WandB：无论用哪种方式，wandb.init()必须在其他文件的类使用WandB对象之前执行，否则会出现未初始化错误。
• 禁止重复初始化：不要在其他文件中再次调用wandb.init()，否则会创建新的run实例，导致日志混乱或冲突。
• 多run场景需显式传递：如果代码涉及多进程/多线程、同时运行多个WandB实验，必须显式传递对应的run对象，不能依赖全局wandb.run，避免不同run的日志混淆。
• 验证对象有效性：如果传递后仍无法记录日志，可在类中打印self.wandb_run或wandb.run，确认是否为有效的WandB Run实例（而非None）。
• 保持版本一致：确保所有文件所在环境的WandB版本相同，版本不一致可能导致对象传递后出现兼容性问题。

内容的提问来源于stack exchange，提问作者Milad Sikaroudi