Metadata-Version: 2.1
Name: auto_model_monitor
Version: 0.1.1
Summary: A tool for monitoring model checkpoints and sending notifications
Home-page: https://github.com/Knighthood2001/model_monitor
Author: knighthood2001
Author-email: 2109695291@qq.com
License: UNKNOWN
Description: # auto_model_monitor
        
        监视模型训练时生成的权重文件，符合条件时发送QQ邮件通知。
        
        # 使用场景
        
        **当你希望在模型训练过程中，当某个指标（例如验证集上的损失或准确率）低于/高于预设阈值时收到邮件通知。这有助于你及时了解模型的性能表现，以便进行必要的调整。**
        
        # 如何使用
        ## 安装依赖
        ```bash
        pip install auto_model_monitor
        ```
        
        ## 获取QQ授权码
        为了给QQ邮箱发送邮件，你需要使用授权码而不是密码。你可以在QQ邮箱的设置中找到它。
        
        **[https://service.mail.qq.com/detail/0/75](https://service.mail.qq.com/detail/0/75)**
        
        ![Alt text](img/1.jpg)
        
        ## 示例代码
        上述配置后，你就可以使用代码了。
        
        测试代码在[tests/test.py](tests/test.py)
        
        ```python
        from auto_model_monitor import ModelMonitor, MonitorConfig, CustomParser
        
        # 自定义解析器
        parser = CustomParser(pattern=r'val_loss_([0-9.]+)_')
        
        # 配置参数
        config = MonitorConfig(
            watch_dir='./quicktest/logs',     # 监控的文件夹路径
            threshold=0.004,                  # 阈值
            sender='2109695291@qq.com',       # 发送邮箱
            receiver='2109695291@qq.com',     # 接收邮箱
            auth_code='xxxx',                 # 邮箱授权码
            check_interval=5,                 # 检查间隔 (秒)
            log_dir='model_monitor_logs',     # 日志文件夹路径
            comparison_mode='lower',          # 比较模式
            parser=parser                     # 使用自定义解析器
        )
        
        # 初始化并启动监控器
        monitor = ModelMonitor(config)
        monitor.start_monitoring()
        ```
        当你的模型权重文件中的分数低于或高于阈值时，你将收到邮件通知。例如：
        
        ![Alt text](img/2.jpg)
        
        
        # 开发日志
        
        2025-07-04 更新：
        - 最初版本发布。
        
        2025-07-05 更新：
        - 代码重构。如果你需要重构前的代码，在[tests/quicktest](tests/quicktest/demo.py)中查看。
        - 代码打包，上传PyPI。
        - 由于`model_monitor`这个名字已经被占用，改为`auto_model_monitor`。
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
