pytorch / xla

Enabling PyTorch on XLA Devices (e.g. Google TPU)
https://pytorch.org/xla
Other
2.49k stars 480 forks source link

Improve documentation for `get_memory_info` #8245

Open miladm opened 1 month ago

miladm commented 1 month ago

📚 Documentation

Improve documentation for get_memory_info. This feature is lightly defined in PyTorchXLA documentation page. Please provide an explanation on what details it pulls and potentially offer examples.

Additionally, it's important to draw a documentation that clarifies how get_memory_info API works such that users can easily compare/contrast it against torch.cuda.mem_get_info

cc @mikegre-google to help follow up @JackCaoG