Skip to content

docs: clarify tracking_mode affects RAM and CPU#1163

Open
hamza-mobeen wants to merge 1 commit intomlco2:masterfrom
hamza-mobeen:docs/tracking-mode-484
Open

docs: clarify tracking_mode affects RAM and CPU#1163
hamza-mobeen wants to merge 1 commit intomlco2:masterfrom
hamza-mobeen:docs/tracking-mode-484

Conversation

@hamza-mobeen
Copy link
Copy Markdown

Closes #484

The tracking_mode parameter appears in config examples throughout the docs but was never explained. This PR adds a dedicated section to configuration.md that clarifies:

  • Accepted values: "machine" (default) and "process"
  • That it affects both RAM and CPU power measurement (not just RAM)
  • That GPU is unaffected
  • Usage examples for config file and Python code

@hamza-mobeen hamza-mobeen requested a review from a team as a code owner April 19, 2026 17:08
@hamza-mobeen hamza-mobeen force-pushed the docs/tracking-mode-484 branch from 6329efd to 480e5db Compare April 19, 2026 17:11
Add a dedicated "Tracking Mode" section to configuration.md explaining
that tracking_mode="machine" (default) measures whole-machine RAM and CPU,
while tracking_mode="process" isolates to the tracked process only.
Also clarifies that GPU is unaffected by this setting.
@hamza-mobeen hamza-mobeen force-pushed the docs/tracking-mode-484 branch from 480e5db to 15aa0d5 Compare April 19, 2026 17:31
Copy link
Copy Markdown
Collaborator

@inimaz inimaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @hamza-mobeen !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tracking Mode - Possibly Confusing Documentation?

2 participants