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

[Doc]: --engine-use-ray is not documented #3758

Closed
hmellor opened this issue Mar 31, 2024 · 0 comments · Fixed by #3810
Closed

[Doc]: --engine-use-ray is not documented #3758

hmellor opened this issue Mar 31, 2024 · 0 comments · Fixed by #3810
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@hmellor
Copy link
Collaborator

hmellor commented Mar 31, 2024

📚 The doc issue

It looks like AsyncEngineArgs are not documented in https://docs.vllm.ai/en/latest/models/engine_args.html, meaning that --engine-use-ray is undocumented:

class AsyncEngineArgs(EngineArgs):
"""Arguments for asynchronous vLLM engine."""
engine_use_ray: bool = False
disable_log_requests: bool = False
max_log_len: Optional[int] = None
@staticmethod
def add_cli_args(
parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
parser = EngineArgs.add_cli_args(parser)
parser.add_argument('--engine-use-ray',
action='store_true',
help='use Ray to start the LLM engine in a '
'separate process as the server process.')
parser.add_argument('--disable-log-requests',
action='store_true',
help='disable logging requests')
parser.add_argument('--max-log-len',
type=int,
default=None,
help='max number of prompt characters or prompt '
'ID numbers being printed in log. '
'Default: unlimited.')
return parser

@hmellor hmellor added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 31, 2024
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 good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant