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

readme : add option, update default value, fix formatting #10271

Merged
merged 5 commits into from
Dec 3, 2024

Conversation

pothitos
Copy link
Contributor

Thanks for the awesome project 🙏

PR title summarizes these three commits for documentation.

@mofosyne
Copy link
Collaborator

FYI for other reviewers https://github.com/ggerganov/llama.cpp/pull/10271/files?w=1 for no whitespace diff.

@pothitos
Copy link
Contributor Author

Thanks for the tip, Brian! I've added another commit to address Markdown formatting issues.

Here’s an overview of the five commits included in this PR.

  1. Introduces --no-display-prompt argument in the documentation.
  2. Fixes the default --ctx-size value in the documentation.
    • This can be verified with llama-cli --help | grep ctx-size
    • The correct value is already present in the server documentation
      | `-c, --ctx-size N` | size of the prompt context (default: 4096, 0 = loaded from model)<br/>(env: LLAMA_ARG_CTX_SIZE) |
  3. Corrects formatting issues in the server documentation caused by extra spaces.
    • You can compare the original documentation here and the updated version here.
  4. and 5. adjust indentation of commands inside lists for better readability.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 17, 2024
@pothitos
Copy link
Contributor Author

pothitos commented Dec 3, 2024

Hello! The reason for force-pushing is to address "This branch has conflicts that must be resolved" messages and ensure the branch is up-to-date while it's still pending merge. Let me know if there's anything else needed!

@ggerganov ggerganov merged commit 82bca22 into ggerganov:master Dec 3, 2024
6 checks passed
netrunnereve pushed a commit to netrunnereve/llama.cpp that referenced this pull request Dec 4, 2024
…10271)

* readme : document --no-display-prompt

* readme : update default prompt context size

* readme : remove unnecessary indentation

Indenting a line with four spaces makes Markdown treat that section as
plain text.

* readme : indent commands under bullets

* readme : indent commands in lettered list
tinglou pushed a commit to tinglou/llama.cpp that referenced this pull request Dec 7, 2024
…10271)

* readme : document --no-display-prompt

* readme : update default prompt context size

* readme : remove unnecessary indentation

Indenting a line with four spaces makes Markdown treat that section as
plain text.

* readme : indent commands under bullets

* readme : indent commands in lettered list
arthw pushed a commit to arthw/llama.cpp that referenced this pull request Dec 20, 2024
…10271)

* readme : document --no-display-prompt

* readme : update default prompt context size

* readme : remove unnecessary indentation

Indenting a line with four spaces makes Markdown treat that section as
plain text.

* readme : indent commands under bullets

* readme : indent commands in lettered list
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 examples server
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants