Move sampling parameters to offline inference docs

vllm-project · May 9, 2024 · bf01b37 · bf01b37
1 parent ea36daa
commit bf01b37
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -72,6 +72,7 @@ Documentation
    :caption: Offline Inference
 
    offline_inference/llm
+   offline_inference/sampling_params
 
 .. toctree::
    :maxdepth: 1
@@ -107,7 +108,6 @@ Documentation
    :maxdepth: 2
    :caption: Developer Documentation
 
-   dev/sampling_params
    dev/engine/engine_index
    dev/kernel/paged_attention
    dev/dockerfile/dockerfile

diff --git a/docs/source/dev/sampling_params.rst → ...rce/offline_inference/sampling_params.rst b/docs/source/dev/sampling_params.rst → ...rce/offline_inference/sampling_params.rst
@@ -1,4 +1,4 @@
-Sampling Params
+Sampling Parameters
 ===============
 
 .. autoclass:: vllm.SamplingParams

diff --git a/docs/source/serving/openai_compatible_server.md b/docs/source/serving/openai_compatible_server.md
@@ -48,7 +48,7 @@ completion = client.chat.completions.create(
 ```
 
 ### Extra Parameters for Chat API
-The following [sampling parameters (click through to see documentation)](../dev/sampling_params.rst) are supported.
+The following [sampling parameters (click through to see documentation)](../offline_inference/sampling_params.rst) are supported.
 
 ```{literalinclude} ../../../vllm/entrypoints/openai/protocol.py
 :language: python
@@ -65,7 +65,7 @@ The following extra parameters are supported:
 ```
 
 ### Extra Parameters for Completions API
-The following [sampling parameters (click through to see documentation)](../dev/sampling_params.rst) are supported.
+The following [sampling parameters (click through to see documentation)](../offline_inference/sampling_params.rst) are supported.
 
 ```{literalinclude} ../../../vllm/entrypoints/openai/protocol.py
 :language: python