Add information for Podman as well as Docker #11660
Conversation
github-actions
bot
added
the
documentation
docs/build.md
Outdated
|
|
||
| You don't need to install Vulkan SDK. It will be installed inside the container. | ||
|
|
||
| ```sh | ||
| # Build the image | ||
| docker build -t llama-cpp-vulkan --target light -f .devops/vulkan.Dockerfile . | ||
|
|
||
| or |
There was a problem hiding this comment.
| or | |
| # or with podman |
missing the comment sign #
docs/build.md
Outdated
| # Then, use it: | ||
| docker run -it --rm -v "$(pwd):/app:Z" --device /dev/dri/renderD128:/dev/dri/renderD128 --device /dev/dri/card1:/dev/dri/card1 llama-cpp-vulkan -m "/app/models/YOUR_MODEL_FILE" -p "Building a website can be done in 10 simple steps:" -n 400 -e -ngl 33 | ||
|
|
||
| or |
There was a problem hiding this comment.
same here, or probably split it into 2 different code blocks to avoid bad copy/paste when user don't know much about it
docs/container.md
Outdated
|
|
||
| Replace `/path/to/models` below with the actual path where you downloaded the models. | ||
|
|
||
| ```bash | ||
| docker run -v /path/to/models:/models ghcr.io/ggerganov/llama.cpp:full --all-in-one "/models/" 7B | ||
| ``` | ||
| or |
There was a problem hiding this comment.
IMO this is now a bit hard to follow, because some people just copy-paste the command one by one without looking at the "or" word.
A better way here is to hide these podman code blocks inside a expandable block
README.md
Outdated
| @@ -242,7 +242,7 @@ The project also includes many example programs and tools using the `llama` libr | |||
|
|
|||
| - Clone this repository and build locally, see [how to build](docs/build.md) | |||
| - On MacOS or Linux, install `llama.cpp` via [brew, flox or nix](docs/install.md) | |||
| - Use a Docker image, see [documentation for Docker](docs/docker.md) | |||
| - Use a container image, see [documentation for containers](docs/container.md) | |||
There was a problem hiding this comment.
| - Use a container image, see [documentation for containers](docs/container.md) | |
| - Use a container image (docker/podman), see [documentation for containers](docs/container.md) |
In case someone do a Ctrl+F search for "docker", they should see it. Also good for SEO.
rhatdan
force-pushed
the
podman
branch
3 times, most recently
from
16f5682 to
74349d3
Compare
| # Build the image | ||
| docker build -t llama-cpp-vulkan --target light -f .devops/vulkan.Dockerfile . | ||
|
|
||
| <details><summary>Docker example</summary>docker build -t llama-cpp-vulkan --target light -f .devops/vulkan.Dockerfile .</details> |
There was a problem hiding this comment.
markdown code block is broken here
also, what I mean is that only the podman command should be put into details block, as not many users use it
most users use docker, so let's make it a bit more straight-forward for them.
We believe Podman is a viable alternative to Docker. Lots of people have moved to Podman, and the project should make sure people adopt it. Signed-off-by: Daniel J Walsh <[email protected]>
We believe Podman is a viable alternative to Docker. Lots of people have moved to Podman, and the project should make sure people adopt it.
Make sure to read the contributing guidelines before submitting a PR