Experiment Impact Tracker 项目教程

Experiment Impact Tracker 项目教程

1. 项目目录结构及介绍

experiment-impact-tracker/
├── docs/
│   ├── ...
├── docsrc/
│   ├── ...
├── examples/
│   ├── my_experiment.py
├── experiment_impact_tracker/
│   ├── compute_tracker.py
│   ├── data_interface.py
│   ├── ...
├── scripts/
│   ├── ...
├── tests/
│   ├── ...
├── .gitignore
├── LICENSE
├── MANIFEST.in
├── README.md
├── setup.cfg
├── setup.py

目录结构介绍

• docs/: 项目文档目录，包含项目的详细文档和使用说明。
• docsrc/: 文档源文件目录，通常用于生成项目文档。
• examples/: 示例代码目录，包含项目的使用示例，如 my_experiment.py。
• experiment_impact_tracker/: 项目核心代码目录，包含主要的Python模块，如 compute_tracker.py 和 data_interface.py。
• scripts/: 脚本目录，包含一些辅助脚本，用于生成报告或处理数据。
• tests/: 测试代码目录，包含项目的单元测试和集成测试。
• .gitignore: Git忽略文件，指定哪些文件或目录不需要被Git管理。
• LICENSE: 项目许可证文件，说明项目的开源许可证类型。
• MANIFEST.in: 用于指定在打包时需要包含的非Python文件。
• README.md: 项目介绍文件，通常包含项目的概述、安装说明和使用指南。
• setup.cfg: 项目配置文件，用于配置Python包的元数据。
• setup.py: Python包的安装脚本，用于安装项目依赖和打包项目。

2. 项目启动文件介绍

examples/my_experiment.py

my_experiment.py 是一个示例启动文件，展示了如何使用 experiment-impact-tracker 来跟踪实验的能源使用、碳排放和计算资源利用情况。

from experiment_impact_tracker.compute_tracker import ImpactTracker

# 创建一个ImpactTracker实例，指定日志目录
tracker = ImpactTracker(<your log directory here>)

# 启动影响监控
tracker.launch_impact_monitor()

# 示例实验代码
# ...

启动步骤

1. 导入模块: 从 experiment_impact_tracker.compute_tracker 导入 ImpactTracker 类。
2. 创建实例: 创建 ImpactTracker 实例，并指定日志目录。
3. 启动监控: 调用 launch_impact_monitor() 方法启动监控。
4. 运行实验: 在监控启动后，运行你的实验代码。

3. 项目配置文件介绍

setup.cfg

setup.cfg 是一个配置文件，用于配置Python包的元数据和构建选项。

[metadata]
name = experiment-impact-tracker
version = 0.1.8
description = A toolkit for tracking energy, carbon, and compute metrics for machine learning (or any other) experiments.
author = Peter Henderson
license = MIT

[options]
packages = find:
install_requires =
    psutil
    nvidia-smi
    ...

配置项介绍

• [metadata]: 包含项目的元数据，如项目名称、版本号、描述、作者和许可证。
• [options]: 包含构建和安装选项，如需要包含的包和依赖项。

setup.py

setup.py 是一个Python脚本，用于安装项目依赖和打包项目。

from setuptools import setup, find_packages

setup(
    name="experiment-impact-tracker",
    version="0.1.8",
    description="A toolkit for tracking energy, carbon, and compute metrics for machine learning (or any other) experiments.",
    author="Peter Henderson",
    license="MIT",
    packages=find_packages(),
    install_requires=[
        "psutil",
        "nvidia-smi",
        ...
    ],
)

配置项介绍

• name: 项目名称。
• version: 项目版本号。
• description: 项目描述。
• author: 项目作者。
• license: 项目许可证。
• packages: 需要包含的Python包。
• install_requires: 项目依赖项。

通过以上配置文件，可以方便地安装和管理 experiment-impact-tracker 项目及其依赖项。