merge master into main

.gitignore

@@ -0,0 +1,97 @@
+venv
+__pycache__
+*.pyc
+flagged/*
+
+# Created by https://www.toptal.com/developers/gitignore/api/pycharm+all
+# Edit at https://www.toptal.com/developers/gitignore?templates=pycharm+all
+
+### PyCharm+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### PyCharm+all Patch ###
+# Ignore everything but code style settings and run configurations
+# that are supposed to be shared within teams.
+
+.idea/*
+
+!.idea/codeStyles
+!.idea/runConfigurations
+
+# End of https://www.toptal.com/developers/gitignore/api/pycharm+all

Dockerfile

@@ -0,0 +1,22 @@
+FROM python:3.11-bookworm AS builder_global
+
+ARG PACKAGE_NAME="app_gradio_fastapi"
+ARG ROOT_DIR="/code"
+WORKDIR ${ROOT_DIR}
+RUN chmod 770 -R ${ROOT_DIR}/
+
+COPY ./requirements.txt ${ROOT_DIR}/requirements.txt
+
+RUN pip install pip --upgrade
+RUN python -m venv venv
+RUN . ${ROOT_DIR}/venv/bin/activate && pip install --no-cache-dir -r ${ROOT_DIR}/requirements.txt
+
+COPY ./scripts ${ROOT_DIR}/scripts
+COPY ./${PACKAGE_NAME} ${ROOT_DIR}/${PACKAGE_NAME}
+
+RUN chmod +x ${ROOT_DIR}/scripts/entrypoint.sh
+
+EXPOSE 7860
+
+CMD ["/code/scripts/entrypoint.sh"]
+# CMD ["uvicorn", "wrappers.main:app", "--host", "0.0.0.0", "--port", "7860"]

README.md

@@ -8,4 +8,37 @@ pinned: false
 license: mit
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Gradio plus FastAPI with UUID logging sessions
+## Run the app in a virtual environment
+
+1. create and activate a virtual environment
+2. install the dependencies
+3. execute the uvicorn webserver
+
+```bash
+# create and activate a virtual environment
+python3 -m venv venv
+source venv/bin/activate
+# install the project dependencies
+python -m pip install pip --upgrade
+python -m pip install -r requirements.txt
+# execute the uvicorn webserver
+uvicorn app_gradio_fastapi.main:app --host 0.0.0.0 --port 7860 --reload
+```
+
+## Run the app within a docker container
+
+Build the docker image and run the container:
+
+```bash
+docker build . --tag app_gradio_fastapi --progress=plain
+docker run -d --name app_gradio_fastapi -p 7860:7860 app_gradio_fastapi; docker logs -f app_gradio_fastapi
+```
+
+To stop all the container and remove all the docker images:
+
+
+```bash
+docker stop $(docker ps -a -q); docker rm $(docker ps -a -q)
+docker rmi $(docker images -q) -f
+```

app_gradio_fastapi/helpers/formatters.py

@@ -0,0 +1,30 @@
+import logging
+from fastapi import HTTPException
+
+from app_gradio_fastapi.helpers import session_logger
+
+
+def divide(a: int, b: int) -> float:
+    logging.info(f"a:{a}, b:{b}.")
+    result = a / b
+    logging.info(f"result:{result}.")
+    return result
+
+
+@session_logger.set_uuid_logging
+def request_formatter(text: str) -> dict:
+    logging.info("start request...")
+    try:
+        logging.info(f"input text we need to treat as an integer: {text}.")
+        b = int(text)
+        transformed_text = f"input after integer cast: {b}."
+        try:
+            result_division = divide(100, b)
+            logging.info(f"some_function, result_division:{result_division}.")
+            return {"text": transformed_text, "result": result_division}
+        except ZeroDivisionError as zde:
+            logging.info(f"exception:{zde}.")
+            raise HTTPException(status_code=500, detail="Internal server error")
+    except ValueError as ve:
+        logging.info(f"exception:{ve}.")
+        raise HTTPException(status_code=500, detail="Internal server error")

app_gradio_fastapi/helpers/session_logger.py

@@ -0,0 +1,36 @@
+import contextvars
+import logging
+from functools import wraps
+from typing import Callable
+
+logging_uuid = contextvars.ContextVar("uuid")
+formatter = '%(asctime)s | %(uuid)s [%(pathname)s:%(module)s %(lineno)d] %(levelname)s | %(message)s'
+
+
+loggingType = logging.CRITICAL | logging.ERROR | logging.WARNING | logging.INFO | logging.DEBUG
+
+
+def change_logging(level_log: loggingType = logging.INFO) -> None:
+    old_factory = logging.getLogRecordFactory()
+
+    def record_factory(*args, **kwargs):
+        record = old_factory(*args, **kwargs)
+        record.uuid = logging_uuid.get("uuid")
+        if isinstance(record.msg, str):
+            record.msg = record.msg.replace("\\", "\\\\").replace("\n", "\\n")
+        return record
+
+    logging.setLogRecordFactory(record_factory)
+    logging.basicConfig(level=level_log, format=formatter, force=True)
+
+
+def set_uuid_logging(func: Callable) -> Callable:
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        import uuid
+
+        current_uuid = f"{uuid.uuid4()}"
+        logging_uuid.set(current_uuid)
+        return func(*args, **kwargs)
+
+    return wrapper

app_gradio_fastapi/main.py

@@ -0,0 +1,23 @@
+import gradio as gr
+from fastapi import FastAPI
+
+from app_gradio_fastapi import routes
+from app_gradio_fastapi.helpers.formatters import request_formatter
+from app_gradio_fastapi.helpers.session_logger import change_logging
+
+
+change_logging()
+
+CUSTOM_GRADIO_PATH = "/"
+app = FastAPI(title="logging_app", version="1.0")
+app.include_router(routes.router)
+io = gr.Interface(
+    request_formatter,
+    inputs=[
+        gr.Textbox(lines=1, placeholder=None, label="Text input"),
+    ],
+    outputs=[
+        gr.Textbox(lines=1, placeholder=None, label="Text Output"),
+    ],
+)
+app = gr.mount_gradio_app(app, io, path=CUSTOM_GRADIO_PATH)

app_gradio_fastapi/routes.py

@@ -0,0 +1,20 @@
+import json
+import logging
+
+from fastapi import APIRouter
+
+from app_gradio_fastapi.helpers import session_logger
+
+
+router = APIRouter()
+
+
+@router.get("/health")
+@session_logger.set_uuid_logging
+def health() -> str:
+    try:
+        logging.info("health check")
+        return json.dumps({"msg": "ok"})
+    except Exception as e:
+        logging.error(f"exception:{e}.")
+        return json.dumps({"msg": "request failed"})

requirements.txt

@@ -0,0 +1,2 @@
+gradio
+fastapi

scripts/entrypoint.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+WORKDIR="/code"
+
+cd ${WORKDIR} || exit
+pwd
+source ${WORKDIR}/venv/bin/activate
+
+which python
+python --version
+which pip
+pip --version
+
+free -m
+pip list
+ls -l
+echo "uvicorn"
+ls -l ${WORKDIR}/venv/bin/uvicorn
+
+# python ${WORKDIR}/app.py --version='xinlai/LISA-13B-llama2-v1-explanatory' --precision='fp16' --load_in_4bit
+echo "${WORKDIR}/venv/bin/uvicorn app_gradio_fastapi.main:app --host 0.0.0.0 --port 7860"
+${WORKDIR}/venv/bin/uvicorn app_gradio_fastapi.main:app --host 0.0.0.0 --port 7860
+
+exit 0