[Docs] Convert rST to MyST (Markdown) (#11145)

Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
This commit is contained in:
Rafael Vasquez
2024-12-23 17:35:38 -05:00
committed by GitHub
parent 94d545a1a1
commit 32aa2059ad
167 changed files with 7863 additions and 8131 deletions

View File

@@ -1,6 +1,7 @@
AsyncLLMEngine
=================================
# AsyncLLMEngine
```{eval-rst}
.. autoclass:: vllm.AsyncLLMEngine
:members:
:show-inheritance:
```

View File

@@ -0,0 +1,17 @@
# vLLM Engine
```{eval-rst}
.. automodule:: vllm.engine
```
```{eval-rst}
.. currentmodule:: vllm.engine
```
```{toctree}
:caption: Engines
:maxdepth: 2
llm_engine
async_llm_engine
```

View File

@@ -1,13 +0,0 @@
vLLM Engine
=================================
.. automodule:: vllm.engine
.. currentmodule:: vllm.engine
.. toctree::
:maxdepth: 2
:caption: Engines
llm_engine
async_llm_engine

View File

@@ -1,6 +1,7 @@
LLMEngine
=================================
# LLMEngine
```{eval-rst}
.. autoclass:: vllm.LLMEngine
:members:
:show-inheritance:
```

View File

@@ -1,6 +1,7 @@
LLM Class
=========
# LLM Class
```{eval-rst}
.. autoclass:: vllm.LLM
:members:
:show-inheritance:
```

View File

@@ -1,14 +1,19 @@
LLM Inputs
==========
# LLM Inputs
```{eval-rst}
.. autodata:: vllm.inputs.PromptType
```
```{eval-rst}
.. autoclass:: vllm.inputs.TextPrompt
:show-inheritance:
:members:
:member-order: bysource
```
```{eval-rst}
.. autoclass:: vllm.inputs.TokensPrompt
:show-inheritance:
:members:
:member-order: bysource
```

View File

@@ -0,0 +1,8 @@
# Offline Inference
```{toctree}
:maxdepth: 1
llm
llm_inputs
```

View File

@@ -1,8 +0,0 @@
Offline Inference
=================================
.. toctree::
:maxdepth: 1
llm
llm_inputs

View File

@@ -1,5 +1,6 @@
Pooling Parameters
==================
# Pooling Parameters
```{eval-rst}
.. autoclass:: vllm.PoolingParams
:members:
```

View File

@@ -1,5 +1,6 @@
Sampling Parameters
===================
# Sampling Parameters
```{eval-rst}
.. autoclass:: vllm.SamplingParams
:members:
```