Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
OpenDAS
vllm_cscc
Commits
4bfa7e7f
Unverified
Commit
4bfa7e7f
authored
May 14, 2024
by
Cyrus Leung
Committed by
GitHub
May 13, 2024
Browse files
[Doc] Add API reference for offline inference (#4710)
parent
ac1fbf7f
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
17 additions
and
5 deletions
+17
-5
docs/source/index.rst
docs/source/index.rst
+7
-1
docs/source/offline_inference/llm.rst
docs/source/offline_inference/llm.rst
+6
-0
docs/source/offline_inference/sampling_params.rst
docs/source/offline_inference/sampling_params.rst
+2
-2
docs/source/serving/openai_compatible_server.md
docs/source/serving/openai_compatible_server.md
+2
-2
No files found.
docs/source/index.rst
View file @
4bfa7e7f
...
@@ -67,6 +67,13 @@ Documentation
...
@@ -67,6 +67,13 @@ Documentation
getting_started/quickstart
getting_started/quickstart
getting_started/examples/examples_index
getting_started/examples/examples_index
.. toctree::
:maxdepth: 1
:caption: Offline Inference
offline_inference/llm
offline_inference/sampling_params
.. toctree::
.. toctree::
:maxdepth: 1
:maxdepth: 1
:caption: Serving
:caption: Serving
...
@@ -101,7 +108,6 @@ Documentation
...
@@ -101,7 +108,6 @@ Documentation
:maxdepth: 2
:maxdepth: 2
:caption: Developer Documentation
:caption: Developer Documentation
dev/sampling_params
dev/engine/engine_index
dev/engine/engine_index
dev/kernel/paged_attention
dev/kernel/paged_attention
dev/dockerfile/dockerfile
dev/dockerfile/dockerfile
...
...
docs/source/offline_inference/llm.rst
0 → 100644
View file @
4bfa7e7f
LLM Class
==========
.. autoclass:: vllm.LLM
:members:
:show-inheritance:
docs/source/
dev
/sampling_params.rst
→
docs/source/
offline_inference
/sampling_params.rst
View file @
4bfa7e7f
Sampling Params
Sampling Param
eter
s
===============
===============
====
.. autoclass:: vllm.SamplingParams
.. autoclass:: vllm.SamplingParams
:members:
:members:
docs/source/serving/openai_compatible_server.md
View file @
4bfa7e7f
...
@@ -48,7 +48,7 @@ completion = client.chat.completions.create(
...
@@ -48,7 +48,7 @@ completion = client.chat.completions.create(
```
```
### Extra Parameters for Chat API
### 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
```
{literalinclude} ../../../vllm/entrypoints/openai/protocol.py
:language: python
:language: python
...
@@ -65,7 +65,7 @@ The following extra parameters are supported:
...
@@ -65,7 +65,7 @@ The following extra parameters are supported:
```
```
### Extra Parameters for Completions API
### 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
```
{literalinclude} ../../../vllm/entrypoints/openai/protocol.py
:language: python
:language: python
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment