add make dev (#12)

* add make dev and related files Signed-off-by: cbh778899 <[email protected]> * update README Signed-off-by: cbh778899 <[email protected]> --------- Signed-off-by: cbh778899 <[email protected]>
SkywardAI · Aug 1, 2024 · af8a410 · af8a410
1 parent 64d7ea5
commit af8a410
Show file tree

Hide file tree

Showing 7 changed files with 83 additions and 9 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -3,12 +3,13 @@
 .github
 .vscode
 .gitignore
-Dockerfile
+*Dockerfile
 README.md
 node_modules
 package-lock.json
 pnpm-lock.yaml
 eslint.config.mjs
 LICENSE
 volumes
-docker-compose.yaml
+docker-compose*
+Makefile
diff --git a/Dockerfile b/Dockerfile
@@ -3,8 +3,6 @@ WORKDIR /app
 COPY . .
 
 HEALTHCHECK --interval=300s --timeout=30s --start-period=5s --retries=3 CMD [ "node", "healthy-check.js" ]
-# RUN npm install -g pnpm && pnpm install
-RUN npm install -g pnpm nodemon && pnpm install
+RUN npm install -g pnpm && pnpm install
 EXPOSE 8000
-# ENTRYPOINT [ "npm", "start" ]
-ENTRYPOINT [ "npm", "run", "dev" ]
+ENTRYPOINT [ "npm", "start" ]
diff --git a/Makefile b/Makefile
@@ -54,10 +54,25 @@ model-prepare:
 	@mkdir -p $(MODEL_SAVE_PATH) && [ -f $(MODEL_SAVE_PATH)/$(LANGUAGE_MODEL_NAME) ] || wget -O $(MODEL_SAVE_PATH)/$(LANGUAGE_MODEL_NAME) $(LANGUAGE_MODEL_URL)
 	@mkdir -p $(MODEL_SAVE_PATH) && [ -f $(MODEL_SAVE_PATH)/$(EMBEDDING_MODEL_NAME) ] || wget -O $(MODEL_SAVE_PATH)/$(EMBEDDING_MODEL_NAME) $(EMBEDDING_MODEL_URL)
 
+#  normal build & up
 .PHONY: compose-build
 compose-build: env model-prepare
 	@docker compose -f docker-compose.yaml build
 
 .PHONY: up
 up: compose-build
 	@docker compose -f docker-compose.yaml up -d
+
+#  dev build & up
+.PHONY: compose-build-dev
+compose-build-dev: env model-prepare
+	@docker compose -f docker-compose-dev.yaml build
+
+.PHONY: dev
+dev: env model-prepare
+	@docker compose -f docker-compose-dev.yaml up -d
+
+# stop
+.PHONY: stop
+stop:
+	docker compose stop
diff --git a/README.md b/README.md
@@ -32,7 +32,12 @@ make build
 # if you want to start only this project in docker, please run
 make start
 # PLEASE NOTE: make start will automatically run make build first
+
+# to run a container bind to your local machine volume, run
+make dev
+# this will do the same thing as `make up` but allows you to make changes and sync with container
 ```
+**NOTE:** `make dev` Requires Node.js environment installed, or at least have `node_modules` specified in `package.json` installed on your server. Please see [Local Machine](#local-machine) section.
 
 ## Lint
 To start lint your code, simply run
@@ -41,4 +46,5 @@ npm run lint
 ```
 
 ## Monitor
-This project got monitor build with swagger-stats, when you got this project running, just go to `<Your Server>:<Your Port>/stats`
+This project got monitor build with swagger-stats, when you got this project running, just go to `<Your Server>:<Your Port>/stats`.  
+For example, [http://localhost:8000/stats](http://localhost:8000/stats)
diff --git a/devDockerfile b/devDockerfile
@@ -0,0 +1,8 @@
+FROM node:20.15.1-slim
+WORKDIR /app
+COPY . .
+
+HEALTHCHECK --interval=300s --timeout=30s --start-period=5s --retries=3 CMD [ "node", "healthy-check.js" ]
+RUN npm install -g pnpm nodemon && pnpm install
+EXPOSE 8000
+ENTRYPOINT [ "npm", "run", "dev" ]
diff --git a/docker-compose-dev.yaml b/docker-compose-dev.yaml
@@ -0,0 +1,48 @@
+services:
+  llamacpp:
+    container_name: ${INFERENCE_ENG}
+    image: gclub/llama.cpp:${INFERENCE_ENG_VERSION}
+    restart: always
+    deploy: # https://github.com/compose-spec/compose-spec/blob/master/deploy.md
+      resources:
+        reservations:
+          cpus: "${NUM_CPU_CORES}"
+    volumes:
+      - "${DOCKER_VOLUME_DIRECTORY:-.}/${MODEL_SAVE_PATH}:/models"
+    expose:
+      - ${ENG_ACCESS_PORT}
+    ports:
+      - ${INFERENCE_ENG_PORT}:${ENG_ACCESS_PORT}
+    command: ["-m", "models/${LANGUAGE_MODEL_NAME}","-c","8192"]
+
+  embedding_eng:
+    container_name: ${EMBEDDING_ENG}
+    image: gclub/llama.cpp:${INFERENCE_ENG_VERSION}
+    restart: always
+    deploy: # https://github.com/compose-spec/compose-spec/blob/master/deploy.md
+      resources:
+        reservations:
+          cpus: "${NUM_CPU_CORES_EMBEDDING}"
+    volumes:
+      - "${DOCKER_VOLUME_DIRECTORY:-.}/${MODEL_SAVE_PATH}:/models"
+    expose:
+      - ${ENG_ACCESS_PORT}
+    ports:
+      - ${EMBEDDING_ENG_PORT}:${ENG_ACCESS_PORT}
+    command: ["-m", "models/${EMBEDDING_MODEL_NAME}","--embeddings","--pooling","mean","-c","512"]
+
+  voyager:
+    container_name: voyager
+    restart: always
+    build:
+      dockerfile: devDockerfile
+      context: .
+    volumes:
+      - .:/app
+    expose:
+      - ${APP_PORT}
+    ports:
+      - ${APP_PORT}:${APP_PORT}
+    depends_on:
+      - llamacpp
+      - embedding_eng
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -37,8 +37,6 @@ services:
     build:
       dockerfile: Dockerfile
       context: .
-    volumes:
-      - .:/app
     expose:
       - ${APP_PORT}
     ports: