Skip to content

docs: add aggregate profiler memory example#4054

Open
aryanputta wants to merge 1 commit into
huggingface:mainfrom
aryanputta:aryan/profiler-memory-docs
Open

docs: add aggregate profiler memory example#4054
aryanputta wants to merge 1 commit into
huggingface:mainfrom
aryanputta:aryan/profiler-memory-docs

Conversation

@aryanputta
Copy link
Copy Markdown

Summary

  • add a small aggregate-memory example to the profiler guide
  • show how to pair Accelerator.profile() with torch.cuda.reset_peak_memory_stats()
  • document a lightweight way to log peak allocated and reserved memory without adding a new manager API

Why

Issue #3300 asks for a memory logging manager, but the maintainer discussion suggests that a documented minimal example may already cover the main need for many users.

Testing

  • docs-only change
  • reviewed rendered markdown locally in diff form

Related

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.

[Feature Request] add a memory logging manager

1 participant