mirror of
https://github.com/NVIDIA/TensorRT-LLM.git
synced 2026-01-14 06:27:45 +08:00
542 lines
54 KiB
HTML
542 lines
54 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" data-content_root="../../../">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>tensorrt_llm.llmapi.build_cache — tensorrt_llm documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css?v=76b2166b" />
|
|
|
|
|
|
<script src="../../../_static/jquery.js?v=5d32c60e"></script>
|
|
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|
<script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
|
|
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
|
|
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
|
|
<script src="../../../_static/copybutton.js?v=65e89d2a"></script>
|
|
<script src="../../../_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="../../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../../search.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
|
|
|
|
|
|
<a href="../../../index.html" class="icon icon-home">
|
|
tensorrt_llm
|
|
</a>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../overview.html">Overview</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../quick-start-guide.html">Quick Start Guide</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../key-features.html">Key Features</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../release-notes.html">Release Notes</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Installation</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../installation/linux.html">Installing on Linux</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../installation/build-from-source-linux.html">Building from Source Code on Linux</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../installation/windows.html">Installing on Windows</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../installation/build-from-source-windows.html">Building from Source Code on Windows</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../installation/grace-hopper.html">Installing on Grace Hopper</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">LLM API</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../llm-api/index.html">API Introduction</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../llm-api/reference.html">API Reference</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">LLM API Examples</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../llm-api-examples/index.html">LLM Examples Introduction</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../llm-api-examples/customization.html">Common Customizations</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../llm-api-examples/llm_api_examples.html">Examples</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Model Definition API</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../python-api/tensorrt_llm.layers.html">Layers</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../python-api/tensorrt_llm.functional.html">Functionals</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../python-api/tensorrt_llm.models.html">Models</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../python-api/tensorrt_llm.plugin.html">Plugin</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../python-api/tensorrt_llm.quantization.html">Quantization</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../python-api/tensorrt_llm.runtime.html">Runtime</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">C++ API</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../_cpp_gen/executor.html">Executor</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../_cpp_gen/runtime.html">Runtime</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Command-Line Reference</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../commands/trtllm-build.html">trtllm-build</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../commands/trtllm-serve.html">trtllm-serve</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Architecture</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../architecture/overview.html">TensorRT-LLM Architecture</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../architecture/core-concepts.html">Model Definition</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../architecture/core-concepts.html#compilation">Compilation</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../architecture/core-concepts.html#runtime">Runtime</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../architecture/core-concepts.html#multi-gpu-and-multi-node-support">Multi-GPU and Multi-Node Support</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../architecture/checkpoint.html">TensorRT-LLM Checkpoint</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../architecture/workflow.html">TensorRT-LLM Build Workflow</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../architecture/add-model.html">Adding a Model</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Advanced</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../advanced/gpt-attention.html">Multi-Head, Multi-Query, and Group-Query Attention</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../advanced/gpt-runtime.html">C++ GPT Runtime</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../advanced/executor.html">Executor API</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../advanced/graph-rewriting.html">Graph Rewriting Module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../advanced/inference-request.html">Inference Request</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../advanced/inference-request.html#responses">Responses</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../advanced/lora.html">Run gpt-2b + LoRA using GptManager / cpp runtime</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../advanced/expert-parallelism.html">Expert Parallelism in TensorRT-LLM</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../advanced/kv-cache-reuse.html">KV cache reuse</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../advanced/speculative-decoding.html">Speculative Sampling</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Performance</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../performance/perf-overview.html">Overview</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../performance/perf-benchmarking.html">Benchmarking</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../performance/perf-best-practices.html">Best Practices</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../performance/perf-analysis.html">Performance Analysis</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../reference/troubleshooting.html">Troubleshooting</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../reference/support-matrix.html">Support Matrix</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../reference/precision.html">Numerical Precision</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../reference/memory.html">Memory Usage of TensorRT-LLM</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Blogs</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../blogs/H100vsA100.html">H100 has 4.6x A100 Performance in TensorRT-LLM, achieving 10,000 tok/s at 100ms to first token</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../blogs/H200launch.html">H200 achieves nearly 12,000 tokens/sec on Llama2-13B with TensorRT-LLM</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../blogs/Falcon180B-H200.html">Falcon-180B on a single H200 GPU with INT4 AWQ, and 6.7x faster Llama-70B over A100</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../blogs/quantization-in-TRT-LLM.html">Speed up inference with SOTA quantization techniques in TRT-LLM</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../blogs/XQA-kernel.html">New XQA-kernel provides 2.4x more Llama-70B throughput within the same latency budget</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../../../index.html">tensorrt_llm</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
|
|
<li class="breadcrumb-item active">tensorrt_llm.llmapi.build_cache</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<h1>Source code for tensorrt_llm.llmapi.build_cache</h1><div class="highlight"><pre>
|
|
<span></span><span class="kn">import</span> <span class="nn">contextlib</span>
|
|
<span class="kn">import</span> <span class="nn">datetime</span>
|
|
<span class="kn">import</span> <span class="nn">enum</span>
|
|
<span class="kn">import</span> <span class="nn">hashlib</span>
|
|
<span class="kn">import</span> <span class="nn">json</span>
|
|
<span class="kn">import</span> <span class="nn">os</span>
|
|
<span class="kn">import</span> <span class="nn">shutil</span>
|
|
<span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">dataclass</span>
|
|
<span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>
|
|
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span>
|
|
|
|
<span class="kn">import</span> <span class="nn">filelock</span>
|
|
|
|
<span class="kn">import</span> <span class="nn">tensorrt_llm</span>
|
|
<span class="kn">from</span> <span class="nn">tensorrt_llm</span> <span class="kn">import</span> <span class="n">BuildConfig</span>
|
|
<span class="kn">from</span> <span class="nn">tensorrt_llm.llmapi.utils</span> <span class="kn">import</span> <span class="n">enable_llm_debug</span><span class="p">,</span> <span class="n">print_colored</span>
|
|
<span class="kn">from</span> <span class="nn">tensorrt_llm.logger</span> <span class="kn">import</span> <span class="n">logger</span>
|
|
|
|
|
|
<span class="k">def</span> <span class="nf">get_build_cache_config_from_env</span><span class="p">()</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="nb">str</span><span class="p">]:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Get the build cache configuration from the environment variables</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">build_cache_enabled</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'TLLM_LLMAPI_BUILD_CACHE'</span><span class="p">)</span> <span class="o">==</span> <span class="s1">'1'</span>
|
|
<span class="n">build_cache_root</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
|
<span class="s1">'TLLM_LLMAPI_BUILD_CACHE_ROOT'</span><span class="p">,</span>
|
|
<span class="s1">'/tmp/.cache/tensorrt_llm/llmapi/'</span><span class="p">)</span> <span class="c1"># nosec B108</span>
|
|
<span class="k">return</span> <span class="n">build_cache_enabled</span><span class="p">,</span> <span class="n">build_cache_root</span>
|
|
|
|
|
|
<div class="viewcode-block" id="BuildCacheConfig">
|
|
<a class="viewcode-back" href="../../../llm-api/reference.html#tensorrt_llm.llmapi.BuildCacheConfig">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">BuildCacheConfig</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Configuration for the build cache.</span>
|
|
|
|
<span class="sd"> Attributes:</span>
|
|
<span class="sd"> cache_root (str): The root directory for the build cache.</span>
|
|
<span class="sd"> max_records (int): The maximum number of records to store in the cache.</span>
|
|
<span class="sd"> max_cache_storage_gb (float): The maximum amount of storage (in GB) to use for the cache.</span>
|
|
|
|
<span class="sd"> Note:</span>
|
|
<span class="sd"> The build-cache assumes the weights of the model are not changed during the execution. If the weights are</span>
|
|
<span class="sd"> changed, you should remove the caches manually.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<div class="viewcode-block" id="BuildCacheConfig.__init__">
|
|
<a class="viewcode-back" href="../../../llm-api/reference.html#tensorrt_llm.llmapi.BuildCacheConfig.__init__">[docs]</a>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">cache_root</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Path</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">max_records</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span>
|
|
<span class="n">max_cache_storage_gb</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">256</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_cache_root</span> <span class="o">=</span> <span class="n">cache_root</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_max_records</span> <span class="o">=</span> <span class="n">max_records</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_max_cache_storage_gb</span> <span class="o">=</span> <span class="n">max_cache_storage_gb</span></div>
|
|
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">cache_root</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Path</span><span class="p">:</span>
|
|
<span class="n">_build_cache_enabled</span><span class="p">,</span> <span class="n">_build_cache_root</span> <span class="o">=</span> <span class="n">get_build_cache_config_from_env</span><span class="p">(</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cache_root</span> <span class="ow">or</span> <span class="n">Path</span><span class="p">(</span><span class="n">_build_cache_root</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">max_records</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_max_records</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span> <span class="nf">max_cache_storage_gb</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">float</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_max_cache_storage_gb</span></div>
|
|
|
|
|
|
|
|
<span class="k">class</span> <span class="nc">BuildCache</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> The BuildCache class is a class that manages the intermediate products from the build steps.</span>
|
|
|
|
<span class="sd"> NOTE: currently, only engine-building is supported</span>
|
|
<span class="sd"> TODO[chunweiy]: add support for other build steps, such as quantization, convert_checkpoint, etc.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="c1"># The version of the cache, will be used to determine if the cache is compatible</span>
|
|
<span class="n">CACHE_VERSION</span> <span class="o">=</span> <span class="mi">0</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">BuildCacheConfig</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
|
|
|
|
<span class="n">_</span><span class="p">,</span> <span class="n">default_cache_root</span> <span class="o">=</span> <span class="n">get_build_cache_config_from_env</span><span class="p">()</span>
|
|
<span class="n">config</span> <span class="o">=</span> <span class="n">config</span> <span class="ow">or</span> <span class="n">BuildCacheConfig</span><span class="p">()</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">cache_root</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">cache_root</span> <span class="ow">or</span> <span class="n">Path</span><span class="p">(</span><span class="n">default_cache_root</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">max_records</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">max_records</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">max_cache_storage_gb</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">max_cache_storage_gb</span>
|
|
|
|
<span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">max_records</span> <span class="o"><</span> <span class="mi">1</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"max_records should be greater than 0"</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">free_storage_in_gb</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">float</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">''' Get the free storage capacity of the cache. '''</span>
|
|
<span class="c1"># measure the root directory</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">cache_root</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
|
|
<span class="n">usage</span> <span class="o">=</span> <span class="n">shutil</span><span class="o">.</span><span class="n">disk_usage</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cache_root</span><span class="o">.</span><span class="n">parent</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">usage</span><span class="o">.</span><span class="n">free</span> <span class="o">/</span> <span class="mi">1024</span><span class="o">**</span><span class="mi">3</span>
|
|
<span class="k">return</span> <span class="mi">0</span>
|
|
|
|
<span class="k">def</span> <span class="nf">get_engine_building_cache_stage</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">build_config</span><span class="p">:</span> <span class="n">BuildConfig</span><span class="p">,</span>
|
|
<span class="n">model_path</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Path</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">force_rebuild</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-></span> <span class="s1">'CachedStage'</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> Get the build step for engine building.</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="n">build_config_str</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prune_build_config_for_cache_key</span><span class="p">(</span>
|
|
<span class="n">build_config</span><span class="o">.</span><span class="n">to_dict</span><span class="p">()),</span>
|
|
<span class="n">sort_keys</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
|
|
<span class="n">kwargs_str</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">kwargs</span><span class="p">,</span> <span class="n">sort_keys</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
|
|
<span class="k">return</span> <span class="n">CachedStage</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">kind</span><span class="o">=</span><span class="n">CacheRecord</span><span class="o">.</span><span class="n">Kind</span><span class="o">.</span><span class="n">Engine</span><span class="p">,</span>
|
|
<span class="n">cache_root</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">cache_root</span><span class="p">,</span>
|
|
<span class="n">force_rebuild</span><span class="o">=</span><span class="n">force_rebuild</span><span class="p">,</span>
|
|
<span class="n">inputs</span><span class="o">=</span><span class="p">[</span><span class="n">build_config_str</span><span class="p">,</span> <span class="n">model_path</span><span class="p">,</span> <span class="n">kwargs_str</span><span class="p">])</span>
|
|
|
|
<span class="k">def</span> <span class="nf">prune_caches</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">has_incoming_record</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> Clean up the cache records to make sure the cache size is within the limit</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> has_incoming_record (bool): If the cache has incoming record, the existing records will be further pruned to</span>
|
|
<span class="sd"> reserve space for the incoming record</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">cache_root</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
|
|
<span class="k">return</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_clean_up_cache_dir</span><span class="p">()</span>
|
|
<span class="n">records</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="k">for</span> <span class="nb">dir</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cache_root</span><span class="o">.</span><span class="n">iterdir</span><span class="p">():</span>
|
|
<span class="n">records</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_load_cache_record</span><span class="p">(</span><span class="nb">dir</span><span class="p">))</span>
|
|
<span class="n">records</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="o">.</span><span class="n">time</span><span class="p">,</span> <span class="n">reverse</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
<span class="n">max_records</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_records</span> <span class="o">-</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">has_incoming_record</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_records</span>
|
|
<span class="c1"># prune the cache to meet max_records and max_cache_storage_gb limitation</span>
|
|
<span class="k">while</span> <span class="nb">len</span><span class="p">(</span><span class="n">records</span><span class="p">)</span> <span class="o">></span> <span class="n">max_records</span> <span class="ow">or</span> <span class="nb">sum</span><span class="p">(</span>
|
|
<span class="n">r</span><span class="o">.</span><span class="n">storage_gb</span> <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">records</span><span class="p">)</span> <span class="o">></span> <span class="bp">self</span><span class="o">.</span><span class="n">max_cache_storage_gb</span><span class="p">:</span>
|
|
<span class="n">record</span> <span class="o">=</span> <span class="n">records</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
|
|
<span class="c1"># remove the directory and its content</span>
|
|
<span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
|
|
|
|
<span class="nd">@staticmethod</span>
|
|
<span class="k">def</span> <span class="nf">prune_build_config_for_cache_key</span><span class="p">(</span><span class="n">build_config</span><span class="p">:</span> <span class="nb">dict</span><span class="p">)</span> <span class="o">-></span> <span class="nb">dict</span><span class="p">:</span>
|
|
<span class="c1"># The BuildCache will be disabled once auto_pp is enabled, so 'auto_parallel_config' should be removed</span>
|
|
<span class="n">black_list</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'auto_parallel_config'</span><span class="p">,</span> <span class="s1">'dry_run'</span><span class="p">]</span>
|
|
<span class="n">dic</span> <span class="o">=</span> <span class="n">build_config</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
|
|
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">black_list</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">dic</span><span class="p">:</span>
|
|
<span class="n">dic</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">dic</span>
|
|
|
|
<span class="k">def</span> <span class="nf">load_cache_records</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="s2">"CacheRecord"</span><span class="p">]:</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> Load all the cache records from the cache directory</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="n">records</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">cache_root</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
|
|
<span class="k">return</span> <span class="n">records</span>
|
|
|
|
<span class="k">for</span> <span class="nb">dir</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cache_root</span><span class="o">.</span><span class="n">iterdir</span><span class="p">():</span>
|
|
<span class="n">records</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_load_cache_record</span><span class="p">(</span><span class="nb">dir</span><span class="p">))</span>
|
|
<span class="k">return</span> <span class="n">records</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_load_cache_record</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cache_dir</span><span class="p">)</span> <span class="o">-></span> <span class="s2">"CacheRecord"</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> Get the cache record from the cache directory</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="n">metadata</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">((</span><span class="n">cache_dir</span> <span class="o">/</span> <span class="s1">'metadata.json'</span><span class="p">)</span><span class="o">.</span><span class="n">read_text</span><span class="p">())</span>
|
|
<span class="n">storage_gb</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">stat</span><span class="p">()</span><span class="o">.</span><span class="n">st_size</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">cache_dir</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="s1">'**/*'</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">f</span><span class="o">.</span><span class="n">is_file</span><span class="p">())</span> <span class="o">/</span> <span class="mi">1024</span><span class="o">**</span><span class="mi">3</span>
|
|
<span class="k">return</span> <span class="n">CacheRecord</span><span class="p">(</span><span class="n">kind</span><span class="o">=</span><span class="n">CacheRecord</span><span class="o">.</span><span class="n">Kind</span><span class="o">.</span><span class="n">__members__</span><span class="p">[</span><span class="n">metadata</span><span class="p">[</span><span class="s1">'kind'</span><span class="p">]],</span>
|
|
<span class="n">storage_gb</span><span class="o">=</span><span class="n">storage_gb</span><span class="p">,</span>
|
|
<span class="n">path</span><span class="o">=</span><span class="n">cache_dir</span><span class="p">,</span>
|
|
<span class="n">time</span><span class="o">=</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">fromisoformat</span><span class="p">(</span>
|
|
<span class="n">metadata</span><span class="p">[</span><span class="s1">'datetime'</span><span class="p">]))</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_clean_up_cache_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> Clean up the files in the cache directory, remove anything that is not in the cache</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="c1"># get all the files and directies in the cache_root</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">cache_root</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
|
|
<span class="k">return</span>
|
|
<span class="k">for</span> <span class="n">file_or_dir</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cache_root</span><span class="o">.</span><span class="n">iterdir</span><span class="p">():</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_cache_valid</span><span class="p">(</span><span class="n">file_or_dir</span><span class="p">):</span>
|
|
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Removing invalid cache directory </span><span class="si">{</span><span class="nb">dir</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">file_or_dir</span><span class="o">.</span><span class="n">is_file</span><span class="p">():</span>
|
|
<span class="n">file_or_dir</span><span class="o">.</span><span class="n">unlink</span><span class="p">()</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="n">file_or_dir</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">is_cache_valid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cache_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> Check if the cache directory is valid</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">cache_dir</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
|
|
<span class="k">return</span> <span class="kc">False</span>
|
|
|
|
<span class="n">metadata_path</span> <span class="o">=</span> <span class="n">cache_dir</span> <span class="o">/</span> <span class="s1">'metadata.json'</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">metadata_path</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
|
|
<span class="k">return</span> <span class="kc">False</span>
|
|
|
|
<span class="n">metadata</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">metadata_path</span><span class="o">.</span><span class="n">read_text</span><span class="p">())</span>
|
|
<span class="k">if</span> <span class="n">metadata</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'version'</span><span class="p">)</span> <span class="o">!=</span> <span class="n">BuildCache</span><span class="o">.</span><span class="n">CACHE_VERSION</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="kc">False</span>
|
|
|
|
<span class="n">content</span> <span class="o">=</span> <span class="n">cache_dir</span> <span class="o">/</span> <span class="s1">'content'</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">content</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
|
|
<span class="k">return</span> <span class="kc">False</span>
|
|
|
|
<span class="k">return</span> <span class="kc">True</span>
|
|
|
|
|
|
<span class="nd">@dataclass</span>
|
|
<span class="k">class</span> <span class="nc">CachedStage</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> CachedStage is a class that represents a stage in the build process, it helps to manage the intermediate product.</span>
|
|
|
|
<span class="sd"> The cache is organized as follows:</span>
|
|
|
|
<span class="sd"> this_cache_dir/ # name is like "engine-<hash>"</span>
|
|
<span class="sd"> metadata.json # the metadata of the cache</span>
|
|
<span class="sd"> content/ # the actual product of the build step, such trt-llm engine directory</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="c1"># The parent should be kept alive by CachedStep instance</span>
|
|
<span class="n">parent</span><span class="p">:</span> <span class="n">BuildCache</span>
|
|
<span class="n">cache_root</span><span class="p">:</span> <span class="n">Path</span>
|
|
<span class="c1"># The inputs will be used to determine if the step needs to be re-run, so all the variables should be put here</span>
|
|
<span class="n">inputs</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Any</span><span class="p">]</span>
|
|
<span class="n">kind</span><span class="p">:</span> <span class="s2">"CacheRecord.Kind"</span>
|
|
<span class="c1"># If force_rebuild is set to True, the cache will be ignored</span>
|
|
<span class="n">force_rebuild</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
|
<span class="k">def</span> <span class="nf">get_hash_key</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="n">lib_version</span> <span class="o">=</span> <span class="n">tensorrt_llm</span><span class="o">.</span><span class="n">__version__</span>
|
|
<span class="n">input_strs</span> <span class="o">=</span> <span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">inputs</span><span class="p">]</span>
|
|
<span class="k">return</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">md5</span><span class="p">(</span>
|
|
<span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">lib_version</span><span class="si">}</span><span class="s2">-</span><span class="si">{</span><span class="n">input_strs</span><span class="si">}</span><span class="s2">"</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span> <span class="c1"># nosec B324</span>
|
|
|
|
<span class="k">def</span> <span class="nf">get_cache_path</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Path</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> The path to the product of the build step, will be overwritten if the step is re-run</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">cache_root</span> <span class="o">/</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">kind</span><span class="o">.</span><span class="n">value</span><span class="si">}</span><span class="s2">-</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">get_hash_key</span><span class="p">()</span><span class="si">}</span><span class="s2">"</span>
|
|
|
|
<span class="k">def</span> <span class="nf">get_engine_path</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Path</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_cache_path</span><span class="p">()</span> <span class="o">/</span> <span class="s1">'content'</span>
|
|
|
|
<span class="k">def</span> <span class="nf">get_cache_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">dict</span><span class="p">:</span>
|
|
<span class="n">res</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s2">"version"</span><span class="p">:</span> <span class="n">BuildCache</span><span class="o">.</span><span class="n">CACHE_VERSION</span><span class="p">,</span>
|
|
<span class="s2">"datetime"</span><span class="p">:</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">isoformat</span><span class="p">(),</span>
|
|
<span class="s2">"kind"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">kind</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
|
|
<span class="p">}</span>
|
|
<span class="k">return</span> <span class="n">res</span>
|
|
|
|
<span class="k">def</span> <span class="nf">is_cached</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> Check if the product of the build step is in the cache</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">force_rebuild</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="kc">False</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_cache_path</span><span class="p">()</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
|
|
<span class="n">metadata</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span>
|
|
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_cache_path</span><span class="p">()</span> <span class="o">/</span> <span class="s1">'metadata.json'</span><span class="p">)</span><span class="o">.</span><span class="n">read_text</span><span class="p">())</span>
|
|
<span class="k">if</span> <span class="n">metadata</span><span class="p">[</span><span class="s2">"version"</span><span class="p">]</span> <span class="o">==</span> <span class="n">BuildCache</span><span class="o">.</span><span class="n">CACHE_VERSION</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="kc">True</span>
|
|
<span class="k">except</span><span class="p">:</span>
|
|
<span class="k">pass</span>
|
|
|
|
<span class="k">return</span> <span class="kc">False</span>
|
|
|
|
<span class="nd">@contextlib</span><span class="o">.</span><span class="n">contextmanager</span>
|
|
<span class="k">def</span> <span class="nf">write_guard</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">''' Guard the cache writing process.</span>
|
|
|
|
<span class="sd"> The cache writing process should be atomic, so the filelock is used to protect the cache writing process. And</span>
|
|
<span class="sd"> the cache metadata will be written to the cache directory.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> final_engien_dir: the final engine directory</span>
|
|
<span class="sd"> '''</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">prune_caches</span><span class="p">(</span><span class="n">has_incoming_record</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
|
|
<span class="n">target_dir</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_cache_path</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="n">enable_llm_debug</span><span class="p">():</span>
|
|
<span class="n">print_colored</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Writing cache to </span><span class="si">{</span><span class="n">target_dir</span><span class="si">}</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"yellow"</span><span class="p">)</span>
|
|
|
|
<span class="c1"># To avoid the cache modification conflict, a dummy directory is used to write the cache, and then rename it to</span>
|
|
<span class="c1"># the target directory</span>
|
|
<span class="n">dummy_target_dir</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">target_dir</span><span class="o">.</span><span class="n">parent</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">target_dir</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">.dummy"</span><span class="p">)</span>
|
|
|
|
<span class="n">dummy_target_dir</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">parents</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">exist_ok</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
<span class="c1"># TODO[chunweiy]: deal with the cache modification conflict</span>
|
|
<span class="n">lock</span> <span class="o">=</span> <span class="n">filelock</span><span class="o">.</span><span class="n">FileLock</span><span class="p">(</span><span class="n">dummy_target_dir</span> <span class="o">/</span> <span class="s1">'.filelock'</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
|
|
|
|
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">dummy_target_dir</span> <span class="o">/</span> <span class="s1">'metadata.json'</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
|
|
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_cache_metadata</span><span class="p">()))</span>
|
|
|
|
<span class="k">with</span> <span class="n">lock</span><span class="p">:</span>
|
|
<span class="k">yield</span> <span class="n">dummy_target_dir</span> <span class="o">/</span> <span class="s1">'content'</span>
|
|
|
|
<span class="c1"># If engine building is successful, rename the dummy directory to the target directory</span>
|
|
<span class="k">if</span> <span class="n">target_dir</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
|
|
<span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="n">target_dir</span><span class="p">)</span>
|
|
<span class="n">shutil</span><span class="o">.</span><span class="n">move</span><span class="p">(</span><span class="n">dummy_target_dir</span><span class="p">,</span> <span class="n">target_dir</span><span class="p">)</span>
|
|
|
|
|
|
<span class="nd">@dataclass</span><span class="p">(</span><span class="n">unsafe_hash</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
<span class="k">class</span> <span class="nc">CacheRecord</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">'''</span>
|
|
<span class="sd"> CacheRecord is a class that represents a record in the cache directory.</span>
|
|
<span class="sd"> '''</span>
|
|
|
|
<span class="k">class</span> <span class="nc">Kind</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span>
|
|
<span class="n">Engine</span> <span class="o">=</span> <span class="s1">'engine'</span>
|
|
<span class="n">Checkpoint</span> <span class="o">=</span> <span class="s1">'checkpoint'</span>
|
|
|
|
<span class="n">kind</span><span class="p">:</span> <span class="n">Kind</span>
|
|
<span class="n">storage_gb</span><span class="p">:</span> <span class="nb">float</span>
|
|
<span class="n">path</span><span class="p">:</span> <span class="n">Path</span>
|
|
<span class="n">time</span><span class="p">:</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span>
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<jinja2.runtime.BlockReference object at 0x7f5e6de7f9e0>
|
|
|
|
<div class="footer">
|
|
<p>
|
|
Copyright © 2024 NVIDIA Corporation
|
|
</p>
|
|
<p>
|
|
<a class="Link" href="https://www.nvidia.com/en-us/about-nvidia/privacy-policy/" target="_blank" rel="noopener"
|
|
data-cms-ai="0">Privacy Policy</a> |
|
|
<a class="Link" href="https://www.nvidia.com/en-us/about-nvidia/privacy-center/" target="_blank" rel="noopener"
|
|
data-cms-ai="0">Manage My Privacy</a> |
|
|
<a class="Link" href="https://www.nvidia.com/en-us/preferences/start/" target="_blank" rel="noopener"
|
|
data-cms-ai="0">Do Not Sell or Share My Data</a> |
|
|
<a class="Link" href="https://www.nvidia.com/en-us/about-nvidia/terms-of-service/" target="_blank"
|
|
rel="noopener" data-cms-ai="0">Terms of Service</a> |
|
|
<a class="Link" href="https://www.nvidia.com/en-us/about-nvidia/accessibility/" target="_blank" rel="noopener"
|
|
data-cms-ai="0">Accessibility</a> |
|
|
<a class="Link" href="https://www.nvidia.com/en-us/about-nvidia/company-policies/" target="_blank"
|
|
rel="noopener" data-cms-ai="0">Corporate Policies</a> |
|
|
<a class="Link" href="https://www.nvidia.com/en-us/product-security/" target="_blank" rel="noopener"
|
|
data-cms-ai="0">Product Security</a> |
|
|
<a class="Link" href="https://www.nvidia.com/en-us/contact/" target="_blank" rel="noopener"
|
|
data-cms-ai="0">Contact</a>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |