Skip to content

Commit ef86585

Browse files
committed
Deployed d37ee87 to 0.6 with MkDocs 1.6.0 and mike 2.1.3
1 parent d37ee87 commit ef86585

File tree

45 files changed

+2158
-1676
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+2158
-1676
lines changed

0.6/cli-reference/chat/index.html

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2445,7 +2445,8 @@
24452445

24462446
<h1 id="gpustack-chat">gpustack chat</h1>
24472447
<p>Chat with a large language model.</p>
2448-
<pre class="highlight"><code class="language-bash">gpustack chat model [prompt]</code></pre>
2448+
<div class="highlight"><pre><span></span><code>gpustack<span class="w"> </span>chat<span class="w"> </span>model<span class="w"> </span><span class="o">[</span>prompt<span class="o">]</span>
2449+
</code></pre></div>
24492450
<h2 id="positional-arguments">Positional Arguments</h2>
24502451
<table>
24512452
<thead>
@@ -2467,27 +2468,30 @@ <h2 id="positional-arguments">Positional Arguments</h2>
24672468
</table>
24682469
<h2 id="one-time-chat-with-a-prompt">One-time Chat with a Prompt</h2>
24692470
<p>If a prompt is provided, it performs a one-time inference. For example:</p>
2470-
<pre class="highlight"><code class="language-bash">gpustack chat llama3 "tell me a joke."</code></pre>
2471+
<div class="highlight"><pre><span></span><code>gpustack<span class="w"> </span>chat<span class="w"> </span>llama3<span class="w"> </span><span class="s2">&quot;tell me a joke.&quot;</span>
2472+
</code></pre></div>
24712473
<p>Example output:</p>
2472-
<pre class="highlight"><code>Why couldn't the bicycle stand up by itself?
2474+
<div class="highlight"><pre><span></span><code>Why couldn&#39;t the bicycle stand up by itself?
24732475

2474-
Because it was two-tired!</code></pre>
2476+
Because it was two-tired!
2477+
</code></pre></div>
24752478
<h2 id="interactive-chat">Interactive Chat</h2>
24762479
<p>If the <code>prompt</code> argument is not provided, you can chat with the large language model interactively. For example:</p>
2477-
<pre class="highlight"><code class="language-bash">gpustack chat llama3</code></pre>
2480+
<div class="highlight"><pre><span></span><code>gpustack<span class="w"> </span>chat<span class="w"> </span>llama3
2481+
</code></pre></div>
24782482
<p>Example output:</p>
2479-
<pre class="highlight"><code>&gt;tell me a joke.
2480-
Here's one:
2483+
<div class="highlight"><pre><span></span><code>&gt;tell me a joke.
2484+
Here&#39;s one:
24812485

2482-
Why couldn't the bicycle stand up by itself?
2486+
Why couldn&#39;t the bicycle stand up by itself?
24832487

24842488
(wait for it...)
24852489

24862490
Because it was two-tired!
24872491

24882492
Hope that made you smile!
24892493
&gt;Do you have a better one?
2490-
Here's another one:
2494+
Here&#39;s another one:
24912495

24922496
Why did the scarecrow win an award?
24932497

@@ -2498,13 +2502,15 @@ <h2 id="interactive-chat">Interactive Chat</h2>
24982502
Hope that one stuck with you!
24992503

25002504
Do you want to hear another one?
2501-
&gt;\quit</code></pre>
2505+
&gt;\quit
2506+
</code></pre></div>
25022507
<h3 id="interactive-commands">Interactive Commands</h3>
25032508
<p>Followings are available commands in interactive chat:</p>
2504-
<pre class="highlight"><code>Commands:
2509+
<div class="highlight"><pre><span></span><code>Commands:
25052510
\q or \quit - Quit the chat
25062511
\c or \clear - Clear chat context in prompt
2507-
\? or \h or \help - Print this help message</code></pre>
2512+
\? or \h or \help - Print this help message
2513+
</code></pre></div>
25082514
<h2 id="connect-to-external-gpustack-server">Connect to External GPUStack Server</h2>
25092515
<p>If you are not running <code>gpustack chat</code> on the server node, or if you are serving on a custom host or port, you should provide the following environment variables:</p>
25102516
<table>

0.6/cli-reference/download-tools/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2359,7 +2359,8 @@
23592359

23602360
<h1 id="gpustack-download-tools">gpustack download-tools</h1>
23612361
<p>Download dependency tools, including llama-box, gguf-parser, and fastfetch.</p>
2362-
<pre class="highlight"><code class="language-bash">gpustack download-tools [OPTIONS]</code></pre>
2362+
<div class="highlight"><pre><span></span><code>gpustack<span class="w"> </span>download-tools<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
2363+
</code></pre></div>
23632364
<h2 id="configurations">Configurations</h2>
23642365
<table>
23652366
<thead>

0.6/cli-reference/draw/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2379,7 +2379,8 @@
23792379

23802380
<h1 id="gpustack-draw">gpustack draw</h1>
23812381
<p>Generate an image with a diffusion model.</p>
2382-
<pre class="highlight"><code class="language-bash">gpustack draw [model] [prompt]</code></pre>
2382+
<div class="highlight"><pre><span></span><code>gpustack<span class="w"> </span>draw<span class="w"> </span><span class="o">[</span>model<span class="o">]</span><span class="w"> </span><span class="o">[</span>prompt<span class="o">]</span>
2383+
</code></pre></div>
23832384
<h2 id="positional-arguments">Positional Arguments</h2>
23842385
<table>
23852386
<thead>

0.6/cli-reference/start/index.html

Lines changed: 51 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2463,7 +2463,8 @@
24632463

24642464
<h1 id="gpustack-start">gpustack start</h1>
24652465
<p>Run GPUStack server or worker.</p>
2466-
<pre class="highlight"><code class="language-bash">gpustack start [OPTIONS]</code></pre>
2466+
<div class="highlight"><pre><span></span><code>gpustack<span class="w"> </span>start<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
2467+
</code></pre></div>
24672468
<h2 id="configurations">Configurations</h2>
24682469
<h3 id="common-options">Common Options</h3>
24692470
<table>
@@ -2735,54 +2736,55 @@ <h3 id="available-environment-variables">Available Environment Variables</h3>
27352736
</table>
27362737
<h2 id="config-file">Config File</h2>
27372738
<p>You can configure start options using a YAML-format config file when starting GPUStack server or worker. Here is a complete example:</p>
2738-
<pre class="highlight"><code class="language-yaml"># Common Options
2739-
debug: false
2740-
data_dir: /path/to/data_dir
2741-
cache_dir: /path/to/cache_dir
2742-
token: mytoken
2743-
ollama_library_base_url: https://registry.mycompany.com
2744-
enable_ray: false
2745-
ray_args: ["--port=6379", "--verbose"]
2746-
2747-
# Server Options
2748-
host: 0.0.0.0
2749-
port: 80
2750-
disable_worker: false
2751-
database_url: postgresql://user:password@hostname:port/db_name
2752-
ssl_keyfile: /path/to/keyfile
2753-
ssl_certfile: /path/to/certfile
2754-
force_auth_localhost: false
2755-
bootstrap_password: myadminpassword
2756-
disable_update_check: false
2757-
model_catalog_file: /path_or_url/to/model_catalog_file
2758-
ray_port: 40096
2759-
ray_client_server_port: 40097
2760-
enable_cors: false
2761-
allow_origins: ["*"]
2762-
allow_credentials: false
2763-
allow_methods: ["GET", "POST"]
2764-
allow_headers: ["Authorization", "Content-Type"]
2765-
2766-
# Worker Options
2767-
server_url: http://your_gpustack_server_url
2768-
worker_name: myworker
2769-
worker_ip: 192.168.1.101
2770-
disable_metrics: false
2771-
disable_rpc_servers: false
2772-
metrics_port: 10151
2773-
worker_port: 10150
2774-
service_port_range: 40000-40063
2775-
rpc_server_port_range: 40064-40095
2776-
ray_node_manager_port: 40098
2777-
ray_object_manager_port: 40099
2778-
ray_worker_port_range: 40100-40131
2779-
log_dir: /path/to/log_dir
2780-
rpc_server_args: ["--verbose"]
2781-
system_reserved:
2782-
ram: 2
2783-
vram: 1
2784-
tools_download_base_url: https://mirror.mycompany.com
2785-
enable_hf_transfer: false</code></pre>
2739+
<div class="highlight"><pre><span></span><code><span class="c1"># Common Options</span>
2740+
<span class="nt">debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
2741+
<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>
2742+
<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>
2743+
<span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mytoken</span>
2744+
<span class="nt">ollama_library_base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://registry.mycompany.com</span>
2745+
<span class="nt">enable_ray</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
2746+
<span class="nt">ray_args</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">&quot;--port=6379&quot;</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">&quot;--verbose&quot;</span><span class="p p-Indicator">]</span>
2747+
2748+
<span class="c1"># Server Options</span>
2749+
<span class="nt">host</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0.0.0.0</span>
2750+
<span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">80</span>
2751+
<span class="nt">disable_worker</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
2752+
<span class="nt">database_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgresql://user:password@hostname:port/db_name</span>
2753+
<span class="nt">ssl_keyfile</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/keyfile</span>
2754+
<span class="nt">ssl_certfile</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/certfile</span>
2755+
<span class="nt">force_auth_localhost</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
2756+
<span class="nt">bootstrap_password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myadminpassword</span>
2757+
<span class="nt">disable_update_check</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
2758+
<span class="nt">model_catalog_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path_or_url/to/model_catalog_file</span>
2759+
<span class="nt">ray_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40096</span>
2760+
<span class="nt">ray_client_server_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40097</span>
2761+
<span class="nt">enable_cors</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
2762+
<span class="nt">allow_origins</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">&quot;*&quot;</span><span class="p p-Indicator">]</span>
2763+
<span class="nt">allow_credentials</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
2764+
<span class="nt">allow_methods</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">&quot;GET&quot;</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">&quot;POST&quot;</span><span class="p p-Indicator">]</span>
2765+
<span class="nt">allow_headers</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">&quot;Authorization&quot;</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">&quot;Content-Type&quot;</span><span class="p p-Indicator">]</span>
2766+
2767+
<span class="c1"># Worker Options</span>
2768+
<span class="nt">server_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://your_gpustack_server_url</span>
2769+
<span class="nt">worker_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myworker</span>
2770+
<span class="nt">worker_ip</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.1.101</span>
2771+
<span class="nt">disable_metrics</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
2772+
<span class="nt">disable_rpc_servers</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
2773+
<span class="nt">metrics_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10151</span>
2774+
<span class="nt">worker_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10150</span>
2775+
<span class="nt">service_port_range</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40000-40063</span>
2776+
<span class="nt">rpc_server_port_range</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40064-40095</span>
2777+
<span class="nt">ray_node_manager_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40098</span>
2778+
<span class="nt">ray_object_manager_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40099</span>
2779+
<span class="nt">ray_worker_port_range</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40100-40131</span>
2780+
<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>
2781+
<span class="nt">rpc_server_args</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">&quot;--verbose&quot;</span><span class="p p-Indicator">]</span>
2782+
<span class="nt">system_reserved</span><span class="p">:</span>
2783+
<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>
2784+
<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">1</span>
2785+
<span class="nt">tools_download_base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://mirror.mycompany.com</span>
2786+
<span class="nt">enable_hf_transfer</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
2787+
</code></pre></div>
27862788

27872789

27882790

0.6/development/index.html

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2349,18 +2349,24 @@ <h1 id="development-guide">Development Guide</h1>
23492349
<h2 id="prerequisites">Prerequisites</h2>
23502350
<p>Install Python (version 3.10 to 3.12).</p>
23512351
<h2 id="set-up-environment">Set Up Environment</h2>
2352-
<pre class="highlight"><code class="language-bash">make install</code></pre>
2352+
<div class="highlight"><pre><span></span><code>make<span class="w"> </span>install
2353+
</code></pre></div>
23532354
<h2 id="run">Run</h2>
2354-
<pre class="highlight"><code class="language-bash">poetry run gpustack</code></pre>
2355+
<div class="highlight"><pre><span></span><code>poetry<span class="w"> </span>run<span class="w"> </span>gpustack
2356+
</code></pre></div>
23552357
<h2 id="build">Build</h2>
2356-
<pre class="highlight"><code class="language-bash">make build</code></pre>
2358+
<div class="highlight"><pre><span></span><code>make<span class="w"> </span>build
2359+
</code></pre></div>
23572360
<p>And check artifacts in <code>dist</code>.</p>
23582361
<h2 id="test">Test</h2>
2359-
<pre class="highlight"><code class="language-bash">make test</code></pre>
2362+
<div class="highlight"><pre><span></span><code>make<span class="w"> </span><span class="nb">test</span>
2363+
</code></pre></div>
23602364
<h2 id="update-dependencies">Update Dependencies</h2>
2361-
<pre class="highlight"><code class="language-bash">poetry add &lt;something&gt;</code></pre>
2365+
<div class="highlight"><pre><span></span><code>poetry<span class="w"> </span>add<span class="w"> </span>&lt;something&gt;
2366+
</code></pre></div>
23622367
<p>Or</p>
2363-
<pre class="highlight"><code class="language-bash">poetry add --group dev &lt;something&gt;</code></pre>
2368+
<div class="highlight"><pre><span></span><code>poetry<span class="w"> </span>add<span class="w"> </span>--group<span class="w"> </span>dev<span class="w"> </span>&lt;something&gt;
2369+
</code></pre></div>
23642370
<p>For dev/testing dependencies.</p>
23652371

23662372

0 commit comments

Comments
 (0)