Duplicate from huggingchat/chat-ui-template

Co-authored-by: Nathan Sarrazin <nsarrazin@users.noreply.huggingface.co>

.env.local

@@ -0,0 +1,36 @@
+MODELS=`[
+  {
+    "name": "Your Model",
+    "promptExamples": [
+      {
+        "title": "Python Fibonacci",
+        "prompt": "How can I write a Python function to generate the nth Fibonacci number?"
+      }, {
+        "title": "What is a meme?",
+        "prompt": "What is a meme, and what's the history behind this word?"
+      }, {
+        "title": "Regex",
+        "prompt": "Create a regex to extract dates from logs"
+      }
+    ],
+    "endpoints": [
+      {
+        "type": "tgi",
+        "url": "http://127.0.0.1:8080"
+      }
+    ],
+    "parameters": {
+      "temperature": 0.7,
+      "top_p": 0.95,
+      "repetition_penalty": 1.2,
+      "top_k": 50,
+      "truncate": 1000,
+      "max_new_tokens": 1024,
+      "stop": ["</s>", "<|>"]
+    }
+  }
+]`
+
+PUBLIC_APP_NAME="Your ChatUI App" 
+
+MONGODB_URL=mongodb://localhost:27017

.gitattributes

@@ -0,0 +1,34 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

Dockerfile

@@ -0,0 +1,60 @@
+FROM ghcr.io/huggingface/chat-ui:latest AS base
+
+FROM ghcr.io/huggingface/text-generation-inference:latest AS final
+
+ARG MODEL_NAME
+ENV MODEL_NAME=${MODEL_NAME}
+
+ENV TZ=Europe/Paris \
+    PORT=3000
+
+# mongo installation
+RUN curl -fsSL https://www.mongodb.org/static/pgp/server-7.0.asc | \
+    gpg -o /usr/share/keyrings/mongodb-server-7.0.gpg \
+   --dearmor
+
+RUN echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-7.0.gpg ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/7.0 multiverse" | tee /etc/apt/sources.list.d/mongodb-org-7.0.list
+
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+    mongodb-org && \
+    rm -rf /var/lib/apt/lists/*
+
+# node installation
+RUN curl -fsSL https://deb.nodesource.com/setup_20.x | /bin/bash -
+
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+    nodejs && \
+    rm -rf /var/lib/apt/lists/*
+
+# image setup
+RUN useradd -m -u 1000 user
+
+RUN mkdir /app
+RUN chown -R 1000:1000 /app
+RUN mkdir /data
+RUN chown -R 1000:1000 /data
+
+# Switch to the "user" user
+USER user
+
+ENV HOME=/home/user \
+    PATH=/home/user/.local/bin:$PATH
+
+RUN npm config set prefix /home/user/.local
+RUN npm install -g dotenv-cli
+
+
+# copy chat-ui from base image
+COPY --from=base --chown=1000 /app/node_modules /app/node_modules
+COPY --from=base --chown=1000 /app/package.json /app/package.json
+COPY --from=base --chown=1000 /app/build /app/build
+
+COPY --from=base --chown=1000 /app/.env /app/.env
+COPY --chown=1000 .env.local /app/.env.local
+
+COPY --chown=1000 entrypoint.sh /app/entrypoint.sh
+
+RUN chmod +x /app/entrypoint.sh
+
+# entrypoint
+ENTRYPOINT [ "/app/entrypoint.sh" ]

README.md

@@ -0,0 +1,12 @@
+---
+title: Chat Ui Template
+emoji: 🚀
+colorFrom: indigo
+colorTo: blue
+sdk: docker
+pinned: false
+app_port: 3000
+suggested_hardware: a10g-small
+---
+
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

entrypoint.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# Make sure `/data/db` directory exists even with persistent storage
+mkdir -p /data/db
+# If app crashed, mongo didn't stop gracefully. Remove all the old *.lock files
+find /data/db -name "*.lock" -type f -exec rm -f {} \; 
+# Start the local Mongo database
+mongod &
+
+# Start the text-generation-inference process
+text-generation-launcher --model-id ${MODEL_NAME} --num-shard 1 --port 8080 --trust-remote-code &
+
+# Wait for text-generation-inference to start
+curl --retry 60 --retry-delay 10 --retry-connrefused http://127.0.0.1:8080/health
+
+# Start the chat-ui process
+dotenv -e /app/.env -c -- node /app/build/index.js -- --host 0.0.0.0 --port 3000
+# Wait for any process to exit
+wait -n
+
+# Exit with status of process that exited first
+exit $?