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

[FEA] raft-ann-bench auto-generate CLI documentation #2153

Open
fy opened this issue Feb 2, 2024 · 0 comments · May be fixed by #2182
Open

[FEA] raft-ann-bench auto-generate CLI documentation #2153

fy opened this issue Feb 2, 2024 · 0 comments · May be fixed by #2182
Labels
feature request New feature or request Vector Search

Comments

@fy
Copy link

fy commented Feb 2, 2024

Is your feature request related to a problem? Please describe.

The documentation is not up-to-date. For example, the default value for --search-mode is actually latency as of now.

Describe the solution you'd like

The CLI documentation should be auto generated. Even better, the detail explanations could be part of the code, and thus auto-generated. We can consider using typer for the CLI interface, which provides a convenient way of generating the doc in markdown (details here).

Describe alternatives you've considered

We use pydoc, but I am not sure if pydoc can generate documentation for CLIs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature or request Vector Search
Projects
None yet
1 participant