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

docs: Fix typo and update description for --embeddings flag #7026

Merged
merged 1 commit into from May 14, 2024

Conversation

louixs
Copy link
Contributor

@louixs louixs commented May 1, 2024

Hi there!

I noticed a discrepancy between the server's README and the --help output of the current server version.

This commit updates the server's README to accurately reflect the latest --help output regarding the --embeddings flag:

"--embeddings: Enable embedding vector output. Default: disabled"

examples/server/README.md Outdated Show resolved Hide resolved
@mofosyne mofosyne added documentation Improvements or additions to documentation review complexity : low Trivial changes to code that most beginner devs (or those who want a break) can tackle. e.g. UI fix labels May 9, 2024
examples/server/README.md Outdated Show resolved Hide resolved
examples/server/README.md Outdated Show resolved Hide resolved
@mofosyne
Copy link
Collaborator

Will merge sometimes today if no one objects.

@mofosyne mofosyne added the merging soon Will merge soon unless anyone objects label May 14, 2024
- Change '--embedding' to '--embeddings' in the README
- Update the description to match the latest --help output
- Added a caution about defining physical batch size
@mofosyne mofosyne merged commit 27f65d6 into ggerganov:master May 14, 2024
24 checks passed
@mofosyne mofosyne removed the merging soon Will merge soon unless anyone objects label May 14, 2024
teleprint-me pushed a commit to teleprint-me/llama.cpp that referenced this pull request May 17, 2024
…v#7026)

- Change '--embedding' to '--embeddings' in the README
- Update the description to match the latest --help output
- Added a caution about defining physical batch size
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 review complexity : low Trivial changes to code that most beginner devs (or those who want a break) can tackle. e.g. UI fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants