[Refactor] Add compile-aware timing and profiling helpers

[vmoens]

Stack from ghstack (oldest at bottom):

• [Feature] Add _Contiguous module and reshape improvements to encoders/decoders #3306
• [BugFix] Fix SliceSampler for torch.compile compatibility #3298
• [Feature] Refactor Dreamer training with async collectors, profiling, and improved config #3308
• [Feature] Add noise argument and scan mode to RSSMRollout #3307
• [Feature] Add explicit dimensions and device support to RSSM modules #3305
• [Refactor] Use compile-aware helpers in Dreamer objectives #3304
• [BugFix] Fix value functions for torch.compile compatibility #3303
• [BugFix] Fix TDLambdaEstimator for torch.compile compatibility #3302
• [BugFix] Optimize DreamerEnv to avoid CUDA sync in done checks #3301
• [Feature] Add allow_done_after_reset parameter to ModelBasedEnvBase #3300
• [BugFix] Fix ModelBasedEnvBase for torch.compile compatibility #3299
• -> [Refactor] Add compile-aware timing and profiling helpers #3297
• [Feature] Support callable scale in IndependentNormal and TanhNormal distributions #3296
• [Refactor] Use non_blocking transfers in distribution modules #3295
• [Refactor] Add WEIGHT_SYNC_TIMEOUT constant for collector weight synchronization #3294
• [Refactor] Remove MUJOCO_EGL_DEVICE_ID auto-setting from torchrl init #3293

Add _maybe_timeit, _maybe_record_function, and _maybe_record_function_decorator
that return nullcontext when inside a torch.compile region. These helpers
prevent graph breaks from timing/profiling code during compilation.

[pytorch-bot]

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/rl/3297

• 📄 Preview Python docs built from this PR

Note: Links to docs will display an error until the docs builds have been completed.

❌ 2 New Failures, 17 Pending

As of commit d64b563 with merge base df00d61 ():

NEW FAILURES - The following jobs have failed:

• Habitat Tests on Linux / tests (3.9, 12.8) / linux-job (gh)
  RuntimeError: Command docker exec -t 437ba575d0857e1f0e7f84464292781415d7ae8c473adf58c7b7e3dad9b28cc0 /exec failed with exit code 1
• Libs Tests on Linux / unittests-gym (3.9, 12.8) / linux-job (gh)
  RuntimeError: Command docker exec -t b2a6edf3d4a80720962c80b19ee1c99e073d1812d72b9e1c9c1ceef9fff2e602 /exec failed with exit code 1

This comment was automatically generated by Dr. CI and updates every 15 minutes.