Index

  1. Overview
    Provides a general introduction to the GPU Monitoring and Carbon Calculation Tool, explaining its purpose and key features.

  2. Installation
    Step-by-step instructions for setting up the tool, including setting up the virtual environment and installing dependencies.

  3. Benchmark Docker Images
    Instructions for managing and building Docker images for benchmarking, including how to add custom benchmarks, understand the directory structure, and pull images from the GitHub Container Registry.

  4. Command-Line Interface
    Explains the available command-line arguments and options for controlling the tool’s behavior and features.

  5. Example Commands
    Provides practical examples of how to run the tool with different configurations using common command-line commands.

  6. Collecting Results
    Details how the tool collects, formats, and stores results, including GPU performance and carbon emission data.

  7. Live Monitoring
    Describes how to enable and use the live monitoring feature to track GPU metrics and benchmark performance in real-time.

  8. Considerations On Accuracy
    Discusses limitations and accuracy considerations regarding the measurement of GPU metrics and carbon emissions.

  9. Future Work and Expansion
    Outlines the future improvements and tasks that are planned or currently being worked on for the tool.