From b321a56bdbc5c2227e109ee186c2c33a9757e7de Mon Sep 17 00:00:00 2001 From: Jojo Ortiz Date: Tue, 21 Nov 2023 17:25:17 -0800 Subject: [PATCH] update docker README with links --- docker/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docker/README.md b/docker/README.md index 56181b2..e112628 100644 --- a/docker/README.md +++ b/docker/README.md @@ -149,7 +149,7 @@ docker rm [CONTAINER_NAME] In this folder, we have the different Dockerfiles for using `pykoi`. ## Building from the Repo -Some of these examples build from the pykoi repository. For example, you can reference the Dockerfile in the `pykoi-retrieval-huggingface`. +Some of these examples build from the pykoi repository. For example, you can reference the Dockerfile in the [`pykoi-retrieval-huggingface`](./pykoi-retrieval-huggingface/Dockerfile). In order to build the docker image, first ensure you are in the base directory of the `pykoi` repo. __You will encounter errors if you're not in the base directory__ @@ -164,7 +164,7 @@ docker build -t pykoi:0.1 . -f docker/pykoi-retrieval-huggingface/Dockerfile ``` ## Building based on pykoi library -There are also examples to build based on the `pykoi` package. These examples install `pykoi` via `pip` and run different applications from there. This relies on the latest pypi released versions. +There are also examples to build based on the `pykoi` package. These examples install `pykoi` via `pip` and run different applications from there. This relies on the latest pypi released versions. To see an example, you can reference the Dockerfile in [`pykoi-cpu-custom`](./pykoi-cpu-custom/Dockerfile). 1. `pykoi-cpu`: The base image for the cpu-based usage. 1. `pykoi-cpu-custom`: When you run this docker image, try to modify the `app.py` and mount it when running the docker container.