Merge pull request #79 from OleSeifert/develop

Finish Sprint 3

Author: samadrita-saha

.DS_Store

@@ -0,0 +1,26 @@
+name: Publish Sphinx Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish_sphinx_docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/setup
+      - name: Install dependencies
+        run: uv sync
+      - name: Sphinx build
+        run: uv run sphinx-build docs/source docs/build/html
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build/html
+          force_orphan: true

.github/workflows/docs.yaml

@@ -129,6 +129,7 @@ celerybeat.pid
 
 # Environments
 .env
+.env.env.lock
 .venv
 env/
 venv/
@@ -175,4 +176,4 @@ cython_debug/
 
 
 # Event logs as they are usually too big in size
-event_logs/*
+event_logs/*

.gitignore

@@ -42,10 +42,10 @@ repos:
           - --no-incremental
           - --disable-error-code=override
 
-      - id: pytest
-        name: run tests
-        entry: pytest
-        args: ["tests"]
-        language: python
-        always_run: true
-        pass_filenames: false
+      # - id: pytest
+      #   name: run tests
+      #   entry: pytest
+      #   args: ["tests"]
+      #   language: python
+      #   always_run: true
+      #   pass_filenames: false

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+FROM python:3.12-slim
+
+WORKDIR /app
+
+# Install uv and dependencies
+RUN pip install --no-cache-dir uv
+
+# Copy pyproject and lock file to install backend dependencies
+COPY pyproject.toml uv.lock ./
+# RUN uv pip install --system .
+RUN uv pip install --system ".[all]" jinja2
+
+# Copy FastAPI backend source code
+COPY backend ./backend
+
+# Expose FastAPI's port
+EXPOSE 8000
+
+# Run the FastAPI application using uvicorn
+CMD ["uvicorn", "backend.main:app", "--host", "0.0.0.0", "--port", "8000"]

backend.Dockerfile

@@ -0,0 +1,2 @@
+# Never send secrets into the docker image
+../.env

backend/.dockerignore

@@ -0,0 +1,50 @@
+"""Contains the schemas for the output format of the API responses."""
+
+from typing import List, Optional
+
+from pydantic import BaseModel
+
+
+class TableModel(BaseModel):
+    """Represents a table with headers and rows."""
+
+    headers: List[str]
+    rows: List[List[str]]
+
+
+class GraphNode(BaseModel):
+    """Represents a node in a graph."""
+
+    id: str
+
+
+class GraphEdge(BaseModel):
+    """Represents an edge with a label in a graph.
+
+    Connects two nodes.
+    """
+
+    from_: str  # `from` is a reserved keyword
+    to: str
+    label: str
+
+    class Config:
+        """Represents a mapping for reserved keywords in Pydantic models."""
+
+        fields = {
+            "from_": "from",
+        }
+
+
+class GraphModel(BaseModel):
+    """Represents a complete graph with nodes and edges."""
+
+    nodes: List[GraphNode]
+    edges: List[GraphEdge]
+
+
+class ResponseSchema(BaseModel):
+    """Represents the response schema for API endpoints."""
+
+    tables: Optional[List[TableModel]] = []
+    graphs: Optional[List[GraphModel]] = []

backend/api/models/schemas/output_format.py

@@ -3,7 +3,7 @@
 import uuid
 from typing import Dict, List, TypeAlias, Union
 
-from fastapi import APIRouter, BackgroundTasks, Depends, Request
+from fastapi import APIRouter, BackgroundTasks, Depends, Request, Query
 
 from backend.api.celonis import get_celonis_connection
 from backend.api.jobs import verify_correct_job_module
@@ -14,23 +14,27 @@
 from backend.celonis_connection.celonis_connection_manager import (
     CelonisConnectionManager,
 )
+from backend.pql_queries import declarative_queries
 
 # **************** Type Aliases ****************
 
-ReturnGraphType: TypeAlias = Dict[
-    str, List[Dict[str, List[Union[str, Dict[str, str]]]]]
-]
+TableType: TypeAlias = Dict[str, Union[List[str], List[List[str]]]]
+GraphType: TypeAlias = Dict[str, List[Dict[str, str]]]
+ReturnGraphType: TypeAlias = Dict[str, Union[List[TableType], List[GraphType]]]
 
 router = APIRouter(
     prefix="/api/declarative-constraints", tags=["Declarative Constraints CC"]
 )
 MODULE_NAME = "declarative_constraints"
 
 
-@router.post("/compute-constraints", status_code=202)
+@router.get("/compute-constraints", status_code=202)
 async def compute_declarative_constraints(
     background_tasks: BackgroundTasks,
     request: Request,
+    min_support: float = Query(0.3, description="Minimum support ratio"),
+    min_confidence: float = Query(0.75, description="Minimum confidence ratio"),
+    fitness_score: float = Query(1.0, description="Fitness score for the constraints"),
     celonis: CelonisConnectionManager = Depends(get_celonis_connection),
 ) -> Dict[str, str]:
     """Computes the declarative constraints and stores it.
@@ -44,6 +48,9 @@ async def compute_declarative_constraints(
           application state via `request.app.state`.
         celonis (optional): The CelonisManager dependency injection.
           Defaults to Depends(get_celonis_connection).
+        min_support: The minimum support ratio for the constraints.
+        min_confidence: The minimum confidence ratio for the constraints.
+        fitness_score: The fitness score for the constraints.
 
     Returns:
         A dictionary containing the job ID of the scheduled task.
@@ -55,13 +62,19 @@ async def compute_declarative_constraints(
 
     # Schedule the worker
     background_tasks.add_task(
-        compute_and_store_declarative_constraints, request.app, job_id, celonis
+        compute_and_store_declarative_constraints,
+        request.app,
+        job_id,
+        celonis,
+        min_support,
+        min_confidence,
+        fitness_score,
     )
 
     return {"job_id": job_id}
 
 
-# **************** Retrieving Declarative Model Attributes ****************
+# **************** Retrieving Declarative Model Attributes - PM4PY ****************
 
 
 @router.get("/get_existance_violations/{job_id}")
@@ -354,3 +367,42 @@ def get_nonchainsuccession_violations(job_id: str, request: Request) -> ReturnGr
     verify_correct_job_module(job_id, request, MODULE_NAME)
 
     return request.app.state.jobs[job_id].result.get("nonchainsuccession", [])
+
+
+# **************** Retrieving Declarative Model Attributes - PQL Queries ****************
+
+
+@router.get("/get_always_after_pql/")
+def get_always_after_pql(
+    request: Request,
+    celonis: CelonisConnectionManager = Depends(get_celonis_connection),
+) -> Dict[str, Union[List[TableType], List[GraphType]]]:
+    """Retrieves the always-after relations via PQL.
+
+    Args:
+        request: The FastAPI request object.
+        celonis: The CelonisManager dependency injection.
+
+    Returns:
+        A JSON object with "tables" and "graphs" keys.
+    """
+    result_df = declarative_queries.get_always_after_relation(celonis)
+    return result_df
+
+
+@router.get("/get_always_before_pql/")
+def get_always_before_pql(
+    request: Request,
+    celonis: CelonisConnectionManager = Depends(get_celonis_connection),
+) -> Dict[str, Union[List[TableType], List[GraphType]]]:
+    """Retrieves the always-before relations via PQL.
+
+    Args:
+        request: The FastAPI request object.
+        celonis: The CelonisManager dependency injection.
+
+    Returns:
+        A JSON object with "tables" and "graphs" keys.
+    """
+    result_df = declarative_queries.get_always_before_relation(celonis)
+    return result_df