Duplicate from huggingchat/chat-ui-template

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

.env.local.template

@@ -0,0 +1,71 @@
+# Use .env.local to change these variables
+# DO NOT EDIT THIS FILE WITH SENSITIVE DATA
+
+MONGODB_URL=${MONGODB_URL}
+MONGODB_DB_NAME=chat-ui
+MONGODB_DIRECT_CONNECTION=false
+
+
+COOKIE_NAME=chat-ui
+HF_ACCESS_TOKEN=#hf_<token> from from https://huggingface.co/settings/token
+
+# used to activate search with web functionality. disabled if not defined
+SERPAPI_KEY=#your serpapi key here
+
+# Parameters to enable "Sign in with HF"
+OPENID_CLIENT_ID=
+OPENID_CLIENT_SECRET=
+OPENID_SCOPES="openid profile" # Add "email" for some providers like Google that do not provide preferred_username
+OPENID_PROVIDER_URL=https://huggingface.co # for Google, use https://accounts.google.com
+
+
+# 'name', 'userMessageToken', 'assistantMessageToken' are required
+MODELS=`[
+  {
+    "name": "${MODEL_NAME}",
+    "chatPromptTemplate": "${MODEL_PROMPT_TEMPLATE}",
+    "preprompt": "",
+    "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": ${MODEL_PARAMS}
+  }
+]`
+OLD_MODELS=`[]`# any removed models, `{ name: string, displayName?: string, id?: string }`
+
+PUBLIC_ORIGIN=${SPACE_HOST}
+PUBLIC_SHARE_PREFIX=${SPACE_HOST}/r
+PUBLIC_GOOGLE_ANALYTICS_ID=#G-XXXXXXXX / Leave empty to disable
+PUBLIC_DEPRECATED_GOOGLE_ANALYTICS_ID=#UA-XXXXXXXX-X / Leave empty to disable
+PUBLIC_ANNOUNCEMENT_BANNERS=`[
+  {
+    "title": "Chat UI is now open sourced on GitHub",
+    "linkTitle": "GitHub repo",
+    "linkHref": "https://github.com/huggingface/chat-ui"
+  }
+]`
+
+PARQUET_EXPORT_DATASET=
+PARQUET_EXPORT_HF_TOKEN=
+PARQUET_EXPORT_SECRET=
+
+PUBLIC_APP_NAME=${APP_NAME} # name used as title throughout the app
+PUBLIC_APP_ASSETS=chatui # used to find logos & favicons in static/$PUBLIC_APP_ASSETS
+PUBLIC_APP_COLOR=${APP_COLOR} # can be any of tailwind colors: https://tailwindcss.com/docs/customizing-colors#default-color-palette
+PUBLIC_APP_DATA_SHARING=#set to 1 to enable disclaimers & options about data sharing
+PUBLIC_APP_DATA_DISCLAIMER=#set to 1 to enable disclaimers about model outputs

.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,126 @@
+ARG MODEL_NAME
+ARG MODEL_PARAMS
+ARG MODEL_PROMPT_TEMPLATE
+ARG APP_COLOR
+ARG APP_NAME
+
+
+FROM node:20 as chatui-builder
+ARG MODEL_NAME
+ARG MODEL_PARAMS
+ARG APP_COLOR
+ARG APP_NAME
+ARG MODEL_PROMPT_TEMPLATE
+
+WORKDIR /app
+
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+    git gettext && \
+    rm -rf /var/lib/apt/lists/*
+
+
+RUN git clone https://github.com/huggingface/chat-ui.git
+
+WORKDIR /app/chat-ui
+
+
+COPY .env.local.template .env.local.template
+
+RUN mkdir defaults
+ADD defaults /defaults
+RUN chmod -R 777 /defaults
+RUN --mount=type=secret,id=MONGODB_URL,mode=0444 \
+    MODEL_NAME="${MODEL_NAME:="$(cat /defaults/MODEL_NAME)"}" && export MODEL_NAME \
+    && MODEL_PARAMS="${MODEL_PARAMS:="$(cat /defaults/MODEL_PARAMS)"}" && export MODEL_PARAMS \
+    && MODEL_PROMPT_TEMPLATE="${MODEL_PROMPT_TEMPLATE:="$(cat /defaults/MODEL_PROMPT_TEMPLATE)"}" && export MODEL_PROMPT_TEMPLATE \
+    && APP_COLOR="${APP_COLOR:="$(cat /defaults/APP_COLOR)"}" && export APP_COLOR \
+    && APP_NAME="${APP_NAME:="$(cat /defaults/APP_NAME)"}" && export APP_NAME \
+    && MONGODB_URL=$(cat /run/secrets/MONGODB_URL > /dev/null | grep '^' || cat /defaults/MONGODB_URL) && export MONGODB_URL && \
+    echo "${MONGODB_URL}" && \
+    envsubst < ".env.local.template" > ".env.local" \ 
+    && rm .env.local.template
+
+
+
+RUN --mount=type=cache,target=/app/.npm \
+    npm set cache /app/.npm && \
+    npm ci
+
+RUN npm run build
+
+FROM ghcr.io/huggingface/text-generation-inference:latest
+
+ARG MODEL_NAME
+ARG MODEL_PARAMS
+ARG MODEL_PROMPT_TEMPLATE
+ARG APP_COLOR
+ARG APP_NAME
+
+ENV TZ=Europe/Paris \
+    PORT=3000
+
+
+
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+    gnupg \
+    curl \
+    gettext && \
+    rm -rf /var/lib/apt/lists/*
+COPY entrypoint.sh.template entrypoint.sh.template
+
+RUN mkdir defaults
+ADD defaults /defaults
+RUN chmod -R 777 /defaults
+
+RUN --mount=type=secret,id=MONGODB_URL,mode=0444 \
+    MODEL_NAME="${MODEL_NAME:="$(cat /defaults/MODEL_NAME)"}" && export MODEL_NAME \
+    && MODEL_PARAMS="${MODEL_PARAMS:="$(cat /defaults/MODEL_PARAMS)"}" && export MODEL_PARAMS \
+    && MODEL_PROMPT_TEMPLATE="${MODEL_PROMPT_TEMPLATE:="$(cat /defaults/MODEL_PROMPT_TEMPLATE)"}" && export MODEL_PROMPT_TEMPLATE \
+    && APP_COLOR="${APP_COLOR:="$(cat /defaults/APP_COLOR)"}" && export APP_COLOR \
+    && APP_NAME="${APP_NAME:="$(cat /defaults/APP_NAME)"}" && export APP_NAME \
+    && MONGODB_URL=$(cat /run/secrets/MONGODB_URL > /dev/null | grep '^' || cat /defaults/MONGODB_URL) && export MONGODB_URL &&  \
+    envsubst < "entrypoint.sh.template" > "entrypoint.sh" \
+    && rm entrypoint.sh.template
+
+
+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/*
+
+RUN mkdir -p /data/db
+RUN chown -R 1000:1000 /data
+
+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/*
+
+RUN mkdir /app
+RUN chown -R 1000:1000 /app
+
+RUN useradd -m -u 1000 user
+
+# 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 pm2
+
+COPY --from=chatui-builder --chown=1000 /app/chat-ui/node_modules /app/node_modules
+COPY --from=chatui-builder --chown=1000 /app/chat-ui/package.json /app/package.json
+COPY --from=chatui-builder --chown=1000 /app/chat-ui/build /app/build
+
+ENTRYPOINT ["/bin/bash"]
+CMD ["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

defaults/APP_COLOR

@@ -0,0 +1 @@
+blue

defaults/APP_NAME

@@ -0,0 +1 @@
+ChatUI

defaults/MODEL_NAME

@@ -0,0 +1 @@
+OpenAssistant/falcon-7b-sft-top1-696

defaults/MODEL_PARAMS

@@ -0,0 +1,8 @@
+{
+      "temperature": 0.9,
+      "top_p": 0.95,
+      "repetition_penalty": 1.2,
+      "top_k": 50,
+      "truncate": 1000,
+      "max_new_tokens": 1024
+}

defaults/MODEL_PROMPT_TEMPLATE

@@ -0,0 +1 @@
+<s>{{#each messages}}{{#ifUser}}[INST] {{#if @first}}{{#if @root.preprompt}}{{@root.preprompt}}\n{{/if}}{{/if}} {{content}} [/INST]{{/ifUser}}{{#ifAssistant}}{{content}}</s> {{/ifAssistant}}{{/each}}

defaults/MONGODB_URL

@@ -0,0 +1 @@
+mongodb://127.0.0.1:27017

entrypoint.sh.template

@@ -0,0 +1,23 @@
+#!/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
+pm2 start /app/build/index.js -i $CPU_CORES --no-daemon &
+
+# Wait for any process to exit
+wait -n
+
+# Exit with status of process that exited first
+exit $?