[Doc] Add API reference for offline inference (vllm-project#4710)

dtrifiro · May 16, 2024 · c75ceb4 · c75ceb4
1 parent f4270f2
commit c75ceb4
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 5 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -67,6 +67,13 @@ Documentation
  getting_started/quickstart
  getting_started/examples/examples_index
 
+.. toctree::
+ :maxdepth: 1
+ :caption: Offline Inference
+
+ offline_inference/llm
+ offline_inference/sampling_params
+
 .. toctree::
  :maxdepth: 1
  :caption: Serving
@@ -101,7 +108,6 @@ Documentation
  :maxdepth: 2
  :caption: Developer Documentation
 
- dev/sampling_params
  dev/engine/engine_index
  dev/kernel/paged_attention
  dev/dockerfile-ubi/dockerfile-ubi

diff --git a/docs/source/offline_inference/llm.rst b/docs/source/offline_inference/llm.rst
@@ -0,0 +1,6 @@
+LLM Class
+==========
+
+.. autoclass:: vllm.LLM
+ :members:
+ :show-inheritance:
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,5 +1,5 @@
-Sampling Params
-===============
+Sampling Parameters
+===================
 
 .. autoclass:: vllm.SamplingParams
  :members:
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