Repository navigation
docs: remove stale runtime_cache_path compile() setting - #4856
Sujendra-23 wants to merge 1 commit into
Conversation
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>
|
Hi @Sujendra-23! Thank you for your pull request and welcome to our community. Action RequiredIn 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. ProcessIn 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 If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
Requested by Sujendra
Description
runtime_cache_pathis documented as acompile()/CompilationSettingsoption, but it is not a field ofCompilationSettingsany more. The runtime cache moved toRuntimeSettings.runtime_cache(the migration table indocsrc/contributors/runtime_settings.rstalready says so). Passing it tocompile()goes throughCompilationSettings(**compilation_options)and is rejected.Two docs still describe the old API:
docsrc/user_guide/compilation/compilation_settings.rst: aruntime_cache_pathrow in the Engine Caching table. Removed.docsrc/tutorials/resource_memory/engine_cache.rst: the "Runtime Cache (TensorRT-RTX)" example passesruntime_cache_path=(anduse_python_runtime=True) todynamo.compile. Replaced withRuntimeSettings(runtime_cache=...)+apply_runtime_settings, and theruntime_cache()context manager, matchingdocsrc/user_guide/runtime_performance/runtime_settings.rst. The documented default path was also stale (/tmp/torch_tensorrt_engine_cache/...); it now points atRUNTIME_CACHE_PATHindynamo/_defaults.py.How I checked: parsed
py/torch_tensorrt/dynamo/_settings.pyand confirmedCompilationSettingshastiming_cache_pathbut noruntime_cache_path; greppedpy/forruntime_cache_path(no matches); checked thatRuntimeSettings,apply_runtime_settingsandruntime_cacheare exported fromtorch_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
Checklist:
🤖 Generated with Claude Code