Skip to content

docs: remove stale runtime_cache_path compile() setting - #4856

Open
Sujendra-23 wants to merge 1 commit into
pytorch:mainfrom
Sujendra-23:fix/docs-stale-runtime-cache-path
Open

Sujendra-23 wants to merge 1 commit into
pytorch:mainfrom
Sujendra-23:fix/docs-stale-runtime-cache-path

Conversation

@Sujendra-23

Copy link
Copy Markdown

Requested by Sujendra

Description

runtime_cache_path is documented as a compile() / CompilationSettings option, but it is not a field of CompilationSettings any more. The runtime cache moved to RuntimeSettings.runtime_cache (the migration table in docsrc/contributors/runtime_settings.rst already says so). Passing it to compile() goes through CompilationSettings(**compilation_options) and is rejected.

Two docs still describe the old API:

  • docsrc/user_guide/compilation/compilation_settings.rst: a runtime_cache_path row in the Engine Caching table. Removed.
  • docsrc/tutorials/resource_memory/engine_cache.rst: the "Runtime Cache (TensorRT-RTX)" example passes runtime_cache_path= (and use_python_runtime=True) to dynamo.compile. Replaced with RuntimeSettings(runtime_cache=...) + apply_runtime_settings, and the runtime_cache() context manager, matching docsrc/user_guide/runtime_performance/runtime_settings.rst. The documented default path was also stale (/tmp/torch_tensorrt_engine_cache/...); it now points at RUNTIME_CACHE_PATH in dynamo/_defaults.py.

How I checked: parsed py/torch_tensorrt/dynamo/_settings.py and confirmed CompilationSettings has timing_cache_path but no runtime_cache_path; grepped py/ for runtime_cache_path (no matches); checked that RuntimeSettings, apply_runtime_settings and runtime_cache are exported from torch_tensorrt.runtime. I did not build the Sphinx docs or run the snippet (no GPU / TensorRT-RTX on my machine).

Docs-only change; no code touched.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project (You can use the linters)
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas and hacks
  • I have made corresponding changes to the documentation
  • I have added tests to verify my fix or my feature
  • New and existing unit tests pass locally with my changes
  • I have added the relevant labels to my PR in so that relevant reviewers are notified

🤖 Generated with Claude Code

runtime_cache_path is no longer a CompilationSettings field (the runtime
cache moved to RuntimeSettings.runtime_cache, see
docsrc/contributors/runtime_settings.rst). Drop it from the compilation
settings table and update the engine cache tutorial to use
RuntimeSettings / the runtime_cache() context manager.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Signed-off-by: Sujendra G Bharadwaj <sujendra2001@gmail.com>
@meta-cla

meta-cla Bot commented Oct 13, 2026

Copy link
Copy Markdown

Hi @Sujendra-23!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 13, 2026
@meta-cla

meta-cla Bot commented Oct 13, 2026

Copy link
Copy Markdown

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@meta-cla meta-cla Bot added the cla signed label Oct 13, 2026
@meta-cla

meta-cla Bot commented Oct 13, 2026

Copy link
Copy Markdown

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@github-actions
github-actions Bot requested a review from narendasan October 13, 2026 06:05

This branch has not been deployed

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

Labels

cla signed documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant