Deployed d5ba626 to 0.3 with MkDocs 1.6.0 and mike 2.1.3

gpustack · Nov 1, 2024 · 362653a · 362653a
1 parent d5ba626
commit 362653a
Show file tree

Hide file tree

Showing 6 changed files with 71 additions and 36 deletions.
diff --git a/0.3/cli-reference/start/index.html b/0.3/cli-reference/start/index.html
@@ -1308,6 +1308,11 @@ <h3 id="common-options">Common Options</h3>
 <td>Directory to store data. Default is OS specific.</td>
 </tr>
 <tr>
+<td><code>--cache-dir</code> value</td>
+<td></td>
+<td>Directory to store cache (e.g., model files). Defaults to <data-dir>/cache.</td>
+</tr>
+<tr>
 <td><code>-t</code> value, <code>--token</code> value</td>
 <td>Auto-generated.</td>
 <td>Shared secret used to add a worker.</td>
@@ -1432,7 +1437,8 @@ <h2 id="config-file">Config File</h2>
 <p>You can configure start options using a YAML-format config file when starting GPUStack server or worker. Here is a complete example:</p>
 <div class="highlight"><pre><span></span><code><span class="c1"># Common Options</span>
 <span class="nt">debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
-<span class="nt">data_dir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/dir</span>
+<span class="nt">data_dir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/data_dir</span>
+<span class="nt">cache_dir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/cache_dir</span>
 <span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mytoken</span>
 
 <span class="c1"># Server Options</span>
@@ -1452,7 +1458,7 @@ <h2 id="config-file">Config File</h2>
 <span class="nt">disable_metrics</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
 <span class="nt">metrics_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10151</span>
 <span class="nt">worker_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10150</span>
-<span class="nt">log_dir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/dir</span>
+<span class="nt">log_dir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/log_dir</span>
 <span class="nt">system_reserved</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">ram</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2</span>
 <span class="w">  </span><span class="nt">vram</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0</span>

diff --git a/0.3/installation/docker-installation/index.html b/0.3/installation/docker-installation/index.html
@@ -1255,7 +1255,8 @@ <h2 id="prerequisites">Prerequisites</h2>
 </ul>
 <h2 id="run-gpustack-with-docker">Run GPUStack with Docker</h2>
 <p>Run the following command to start the GPUStack server:</p>
-<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span>--gpus<span class="w"> </span>all<span class="w"> </span>-p<span class="w"> </span><span class="m">80</span>:80<span class="w"> </span>--ipc<span class="o">=</span>host<span class="w"> </span>gpustack/gpustack
+<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span>--gpus<span class="w"> </span>all<span class="w"> </span>-p<span class="w"> </span><span class="m">80</span>:80<span class="w"> </span>--ipc<span class="o">=</span>host<span class="w"> </span><span class="se">\</span>
+<span class="w">    </span>-v<span class="w"> </span>gpustack-data:/var/lib/gpustack<span class="w"> </span>gpustack/gpustack
 </code></pre></div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>

diff --git a/0.3/search/search_index.json b/0.3/search/search_index.json
diff --git a/0.3/sitemap.xml b/0.3/sitemap.xml
@@ -2,162 +2,162 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://docs.gpustack.ai/0.3/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/api-reference/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/architecture/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/code-of-conduct/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/contributing/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/development/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/overview/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/quickstart/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/scheduler/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/troubleshooting/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/upgrade/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/cli-reference/chat/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/cli-reference/start/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/installation/docker-installation/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/installation/installation-script/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/installation/manual-installation/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/installation/uninstallation/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/tutorials/creating-text-embeddings/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/tutorials/inference-on-cpus/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/tutorials/performing-distributed-inference-across-workers/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/tutorials/running-inference-with-ascend-npus/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/tutorials/running-on-copilot-plus-pcs-with-snapdragon-x/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/tutorials/setting-up-a-multi-node-gpustack-cluster/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/tutorials/using-reranker-models/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/tutorials/using-vision-language-models/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/user-guide/api-key-management/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/user-guide/inference-backends/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/user-guide/model-management/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/user-guide/openai-compatible-apis/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/user-guide/playground/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/user-guide/rerank-api/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://docs.gpustack.ai/0.3/user-guide/user-management/</loc>
-         <lastmod>2024-10-31</lastmod>
+         <lastmod>2024-11-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
diff --git a/0.3/sitemap.xml.gz b/0.3/sitemap.xml.gz
diff --git a/0.3/user-guide/rerank-api/index.html b/0.3/user-guide/rerank-api/index.html
@@ -700,6 +700,15 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#supported-models" class="md-nav__link">
+    <span class="md-ellipsis">
+      Supported Models
+    </span>
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#usage" class="md-nav__link">
     <span class="md-ellipsis">
@@ -1149,6 +1158,15 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#supported-models" class="md-nav__link">
+    <span class="md-ellipsis">
+      Supported Models
+    </span>
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#usage" class="md-nav__link">
     <span class="md-ellipsis">
@@ -1196,6 +1214,16 @@ <h1 id="rerank-api">Rerank API</h1>
 <p class="admonition-title">Note</p>
 <p>The Rerank API is only available when using the llama-box <a href="../inference-backends/">inference backend</a>.</p>
 </div>
+<h2 id="supported-models">Supported Models</h2>
+<p>The following models are available for reranking:</p>
+<ul>
+<li><a href="https://huggingface.co/gpustack/bce-reranker-base_v1-GGUF">bce-reranker-base_v1</a></li>
+<li><a href="https://huggingface.co/gpustack/jina-reranker-v1-turbo-en-GGUF">jina-reranker-v1-turbo-en</a></li>
+<li><a href="https://huggingface.co/gpustack/jina-reranker-v1-tiny-en-GGUF">jina-reranker-v1-tiny-en</a></li>
+<li><a href="https://huggingface.co/gpustack/bge-reranker-v2-m3-GGUF">bge-reranker-v2-m3</a></li>
+<li><a href="https://huggingface.co/gpustack/gte-multilingual-reranker-base-GGUF">gte-multilingual-reranker-base</a> <span title="experimental">🧪</span></li>
+<li><a href="https://huggingface.co/gpustack/jina-reranker-v2-base-multilingual-GGUF">jina-reranker-v2-base-multilingual</a> <span title="experimental">🧪</span></li>
+</ul>
 <h2 id="usage">Usage</h2>
 <p>The following is an example using the Rerank API:</p>
 <div class="highlight"><pre><span></span><code><span class="nb">export</span><span class="w"> </span><span class="nv">GPUSTACK_API_KEY</span><span class="o">=</span>myapikey