Merge pull request #6 from RobGeada/READMEandEVAL

Flesh out readme, add optional llm eval module

Author: RobGeada

Dockerfile

@@ -2,17 +2,22 @@
 
 FROM registry.access.redhat.com/ubi8/python-311:latest
 
+ARG EXTRAS=""
+
+
 WORKDIR /app
 
-COPY pyproject.toml poetry.lock* ./
+COPY pyproject.toml poetry.lock* README.md ./
+
+
 
 USER root
-RUN pip install poetry==1.6.1 && \
-    poetry export -f requirements.txt --without dev > requirements.txt && \
-    pip install --no-cache-dir -r requirements.txt
+RUN pip install uv==0.6.16 && \
+    uv pip install .[$EXTRAS]
 COPY . .
 USER 1001
 EXPOSE 4443
 
-#CMD ["uvicorn", "src.main:app", "--host", "0.0.0.0", "--port", "4443", "--ssl-keyfile", "/etc/tls/internal/tls.key", "--ssl-certfile", "/etc/tls/internal/tls.crt", "--log-level", "trace"]
-CMD ["uvicorn", "src.main:app", "--host", "0.0.0.0", "--port", "4443", "--ssl-keyfile", "/etc/tls/internal/tls.key", "--ssl-certfile", "/etc/tls/internal/tls.crt"]
+
+CMD ["uvicorn", "src.main:app", "--host", "0.0.0.0", "--port", "8080"]
+#CMD ["uvicorn", "src.main:app", "--host", "0.0.0.0", "--port", "4443", "--ssl-keyfile", "/etc/tls/internal/tls.key", "--ssl-certfile", "/etc/tls/internal/tls.crt"]

README.md

@@ -1 +1,70 @@
-# trustyai-service-v2
+# TrustyAI Service
+
+👋 The TrustyAI Service is intended to a hub for all kinds of Responsible AI workflows, such as 
+explainability, drift, and Large Language Model (LLM) evaluation. Designed as a REST server wrapping
+a core Python library, the TrustyAI service is intended to be a tool that can operate in a local
+environment, a Jupyter Notebook, or in Kubernetes.
+
+---
+## Native Algorithms
+### 📈Drift  📉
+- Fourier Maximum Mean Discrepancy (FourierMMD)
+- Jensen-Shannon
+- Approximate Kolmogorov–Smirnov Test
+- Kolmogorov–Smirnov Test (KS-Test)
+- Meanshift
+
+### ⚖️ Fairness ⚖️
+- Statistical Parity Difference 
+- Disparate Impact Ratio
+- Average Odds Ratio (WIP)
+- Average Predictive Value Difference (WIP)
+- Individual Consistency (WIP)
+
+---
+## Imported Algorithms/Libraries
+### 🔬Explainability 🔬
+- [LIME](https://github.com/marcotcr/lime) (WIP)
+- [SHAP](https://github.com/shap/shap) (WIP)
+
+### 📋 LLM Evaluation  📋
+- [LM-Evaluation-Harness](https://github.com/EleutherAI/lm-evaluation-harness/tree/main)
+
+---
+## 📦 Building 📦
+### Locally (Without Eval Support)
+```bash
+uv pip install .
+````
+
+### Locally (With Eval Support)
+```bash
+uv pip install .[eval]
+````
+
+### Container (Without Eval Support)
+```bash
+podman build -t $IMAGE_NAME .
+````
+
+### Container (With Eval Support)
+```bash
+podman build -t $IMAGE_NAME --build-arg EXTRAS=eval .
+````
+
+
+## 🏃Running 🏃‍♀️
+### Locally
+```bash
+uv run uvicorn src.main --host 0.0.0.0 --port 8080
+```
+
+### Container
+```bash
+podman run -t $IMAGE_NAME -p 8080:8080 .
+```
+
+---
+## ☎️ API ☎️
+When the service is running, visit [localhost:8080](localhost:8080/docs) to see the OpenAPI documentation!
+

pyproject.toml

@@ -20,7 +20,7 @@ dependencies = [
     "h5py>=3.13.0,<4",
 ]
 
-[dependency-groups]
+[project.optional-dependencies]
 dev = [
     "pytest>=7.4.2,<8",
     "isort>=5.12.0,<6",
@@ -29,6 +29,11 @@ dev = [
     "pytest-cov>=4.1.0,<5",
     "httpx>=0.25.0,<0.26",
 ]
+eval = [
+    "lm-eval[api]==0.4.4",
+    "fastapi-utils>=0.8.0",
+    "typing-inspect==0.9.0",
+]
 
 [tool.hatch.build.targets.sdist]
 include = ["src"]