Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Where is the API reference? #395

Closed
havietisov opened this issue Jul 7, 2023 · 4 comments
Closed

Where is the API reference? #395

havietisov opened this issue Jul 7, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@havietisov
Copy link

I cannot find API reference anywhere, so how am I supposed to use it?

@LiuXiaoxuanPKU
Copy link
Collaborator

LiuXiaoxuanPKU commented Jul 7, 2023

Quickstart might be helpful: https://vllm.readthedocs.io/en/latest/getting_started/quickstart.html
You can also checkout supported models here: https://vllm.readthedocs.io/en/latest/models/supported_models.html
The examples and benchmarks folders also include multiple use cases: https://github.com/vllm-project/vllm/tree/main/examples, https://github.com/vllm-project/vllm/tree/main/benchmarks

@havietisov
Copy link
Author

Eh, well, I would like to see exactly the API reference. For instance, on how to use SamplingParams, what arguments are there, etc.

@WoosukKwon WoosukKwon added the documentation Improvements or additions to documentation label Jul 8, 2023
@kir152
Copy link

kir152 commented Jan 17, 2024

vllm servers are built on top of FastAPI. This means that servers created with FastAPI will automatically have the API documentation available at the /docs endpoint.
eg:
if you are running a vllm server locally, go to http://localhost:8080/docs

@hmellor hmellor closed this as completed Apr 4, 2024
joerunde pushed a commit to joerunde/vllm that referenced this issue Aug 1, 2024
SUMMARY:
* fix issue with logit bias loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants