Spaces:

lablab-ai-amd-developer-hackathon
/

ClauseGuard-AI

Sleeping

App Files Files Community

muhammadbinmurtza commited on 13 days ago

Commit

913a064

1 Parent(s): 9a280b0

Restructure: clauseguard as package subfolder, app_file: clauseguard/app.py

Browse files

Files changed (36) hide show

.gitattributes +0 -35
.gitignore +0 -4
README.md +20 -81
{.streamlit → clauseguard/.streamlit}/config.toml +0 -0
__init__.py → clauseguard/__init__.py +0 -0
{agents → clauseguard/agents}/__init__.py +0 -0
{agents → clauseguard/agents}/classifier.py +0 -0
{agents → clauseguard/agents}/copilot.py +0 -0
{agents → clauseguard/agents}/extractor.py +0 -0
{agents → clauseguard/agents}/orchestrator.py +0 -0
{agents → clauseguard/agents}/reporter.py +0 -0
{agents → clauseguard/agents}/risk_scorer.py +0 -0
{agents → clauseguard/agents}/translator.py +0 -0
app.py → clauseguard/app.py +0 -0
{config → clauseguard/config}/__init__.py +0 -0
{config → clauseguard/config}/copilot_prompts.py +0 -0
{config → clauseguard/config}/prompts.py +0 -0
{config → clauseguard/config}/settings.py +0 -0
main.py → clauseguard/main.py +0 -0
{models → clauseguard/models}/__init__.py +0 -0
{models → clauseguard/models}/clause.py +0 -0
{models → clauseguard/models}/findings.py +0 -0
{models → clauseguard/models}/report.py +0 -0
{sample_contracts → clauseguard/sample_contracts}/sample_employment.txt +0 -0
{sample_contracts → clauseguard/sample_contracts}/sample_freelance.txt +0 -0
{sample_contracts → clauseguard/sample_contracts}/sample_nda.txt +0 -0
{services → clauseguard/services}/__init__.py +0 -0
{services → clauseguard/services}/model_service.py +0 -0
{tests → clauseguard/tests}/__init__.py +0 -0
{tests → clauseguard/tests}/test_extractor.py +0 -0
{tests → clauseguard/tests}/test_pipeline.py +0 -0
{tests → clauseguard/tests}/test_risk_scorer.py +0 -0
{tools → clauseguard/tools}/__init__.py +0 -0
{tools → clauseguard/tools}/clause_tools.py +0 -0
{tools → clauseguard/tools}/file_tools.py +0 -0
{tools → clauseguard/tools}/report_tools.py +0 -0

.gitattributes DELETED Viewed

@@ -1,35 +0,0 @@
-*.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
-*.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

.gitignore CHANGED Viewed

@@ -2,7 +2,3 @@ __pycache__/
 .pytest_cache/
 .env
 *.pyc
-report.md
-clauseGuard-AI/
-documents/
-frontend/

 .pytest_cache/
 .env
 *.pyc

README.md CHANGED Viewed

@@ -5,7 +5,7 @@ colorFrom: indigo
 colorTo: purple
 sdk: streamlit
 sdk_version: "1.31.0"
-app_file: app.py
 pinned: false
 license: mit
 ---
@@ -19,100 +19,39 @@ Upload any contract (PDF, TXT, DOCX). ClauseGuard runs it through a 5-agent AI p
 **5-Agent AI Pipeline:** Extractor → Classifier → Risk Scorer → Translator → Reporter
 ```
   ┌──────────┐    ┌───────────┐    ┌─────────────┐    ┌──────────────┐    ┌──────────┐
-  │ Extractor│───▶│Classifier │───▶│ Risk Scorer │───▶│  Translator  │───▶│ Reporter │
-  │ (Agent 1)│    │ (Agent 2) │    │  (Agent 3)  │    │  (Agent 4)   │    │ (Agent 5)│
   └──────────┘    └───────────┘    └─────────────┘    └──────────────┘    └──────────┘
-       │               │                 │                   │                 │
-       ▼               ▼                 ▼                   ▼                 ▼
-  Split text      Assign types     Score severity      Plain English     Final markdown
-  into clauses    + contract       per clause          + actions         report
-                  type
 ```
-Agents communicate via OpenAI Agents SDK `handoff()`, passing structured Pydantic v2 output at each stage. If any agent times out (30s limit) or fails, the pipeline continues with partial data — the Reporter always produces a FinalReport.
-## Prerequisites
-- Python 3.11+
-- [DeepSeek API key](https://platform.deepseek.com/) (OpenAI-compatible endpoint)
-## Setup
 ```bash
-# Clone the repository
-git clone <repo-url>
-cd clauseguard
-# Install dependencies
 pip install -r requirements.txt
-# Configure your API key
-cp .env.example .env
-# Edit .env and add your DEEPSEEK_API_KEY
-```
-## Usage
-### CLI
-```bash
-python main.py --file sample_contracts/sample_nda.txt
-python main.py --file sample_contracts/sample_nda.txt --output my_report.md
-```
-### Streamlit UI
-```bash
-streamlit run app.py
 ```
-Open http://localhost:8501 in your browser, upload a contract, and click Analyze.
-### Run Tests
-```bash
-pytest tests/ -v
 ```
-## Sample Output
-```markdown
-# ClauseGuard Risk Report
-**Contract:** sample_nda.txt
-**Type:** NDA
-**Overall Risk Score:** 5.0/10
-## Top 3 Actions Before Signing
-1. Demand a carve-out for inventions created on own time using own equipment
-2. Negotiate to limit the non-compete to specific geographic regions
-3. Negotiate to add an opt-out clause for arbitration
-## Risk Summary
-| Severity | Count |
-|----------|-------|
-| 🔴 Critical | 1 |
-| 🟠 High | 2 |
-| 🟡 Medium | 1 |
-| 🟢 Low | 2 |
-| ℹ️ Info | 2 |
-```
-## AMD Developer Cloud Deployment
-ClauseGuard is designed to run on AMD Developer Cloud infrastructure. The DeepSeek API provides the LLM backend, and the application itself is a lightweight Python service suitable for containerized deployment.
-### Docker deployment
-```dockerfile
-FROM python:3.11-slim
-WORKDIR /app
-COPY requirements.txt .
-RUN pip install -r requirements.txt
-COPY . .
-ENV STREAMLIT_SERVER_PORT=8501
-EXPOSE 8501
-CMD ["streamlit", "run", "app.py", "--server.address=0.0.0.0"]
 ```
 ## License

 colorTo: purple
 sdk: streamlit
 sdk_version: "1.31.0"
+app_file: clauseguard/app.py
 pinned: false
 license: mit
 ---
 **5-Agent AI Pipeline:** Extractor → Classifier → Risk Scorer → Translator → Reporter
 ```
+  Upload Contract
+       │
+       ▼
   ┌──────────┐    ┌───────────┐    ┌─────────────┐    ┌──────────────┐    ┌──────────┐
+  │Extractor │───▶│Classifier │───▶│ Risk Scorer  │───▶│  Translator  │───▶│ Reporter │
+  │ (Agent 1)│    │ (Agent 2) │    │  (Agent 3)   │    │  (Agent 4)   │    │(Agent 5) │
   └──────────┘    └───────────┘    └─────────────┘    └──────────────┘    └──────────┘
 ```
+## Features
+- **5-Agent AI Pipeline** — Extractor, Classifier, Risk Scorer, Translator, Reporter
+- **Risk Severity Levels** — CRITICAL, HIGH, MEDIUM, LOW, INFO
+- **Plain English Translations** — Every clause explained in simple language
+- **Negotiation Copilot** — Pre-written messages and safer clause alternatives
+- **AI Chat Assistant** — Full contract context chat for follow-up questions
+- **Multi-format Downloads** — Markdown, CSV, and safer contract
+## Quick Start
 ```bash
 pip install -r requirements.txt
+streamlit run clauseguard/app.py
 ```
+## Configuration
+Set environment variables or create a `.env` file:
 ```
+API_KEY=EMPTY
+BASE_URL=http://165.245.141.170:8000/v1
+MODEL_NAME=Qwen/Qwen2.5-1.5B-Instruct
 ```
 ## License

{.streamlit → clauseguard/.streamlit}/config.toml RENAMED Viewed

File without changes

__init__.py → clauseguard/__init__.py RENAMED Viewed

File without changes

{agents → clauseguard/agents}/__init__.py RENAMED Viewed

File without changes

{agents → clauseguard/agents}/classifier.py RENAMED Viewed

File without changes

{agents → clauseguard/agents}/copilot.py RENAMED Viewed

File without changes

{agents → clauseguard/agents}/extractor.py RENAMED Viewed

File without changes

{agents → clauseguard/agents}/orchestrator.py RENAMED Viewed

File without changes

{agents → clauseguard/agents}/reporter.py RENAMED Viewed

File without changes

{agents → clauseguard/agents}/risk_scorer.py RENAMED Viewed

File without changes

{agents → clauseguard/agents}/translator.py RENAMED Viewed

File without changes

app.py → clauseguard/app.py RENAMED Viewed

File without changes

{config → clauseguard/config}/__init__.py RENAMED Viewed

File without changes

{config → clauseguard/config}/copilot_prompts.py RENAMED Viewed

File without changes

{config → clauseguard/config}/prompts.py RENAMED Viewed

File without changes

{config → clauseguard/config}/settings.py RENAMED Viewed

File without changes

main.py → clauseguard/main.py RENAMED Viewed

File without changes

{models → clauseguard/models}/__init__.py RENAMED Viewed

File without changes

{models → clauseguard/models}/clause.py RENAMED Viewed

File without changes

{models → clauseguard/models}/findings.py RENAMED Viewed

File without changes

{models → clauseguard/models}/report.py RENAMED Viewed

File without changes

{sample_contracts → clauseguard/sample_contracts}/sample_employment.txt RENAMED Viewed

File without changes

{sample_contracts → clauseguard/sample_contracts}/sample_freelance.txt RENAMED Viewed

File without changes

{sample_contracts → clauseguard/sample_contracts}/sample_nda.txt RENAMED Viewed

File without changes

{services → clauseguard/services}/__init__.py RENAMED Viewed

File without changes

{services → clauseguard/services}/model_service.py RENAMED Viewed

File without changes

{tests → clauseguard/tests}/__init__.py RENAMED Viewed

File without changes

{tests → clauseguard/tests}/test_extractor.py RENAMED Viewed

File without changes

{tests → clauseguard/tests}/test_pipeline.py RENAMED Viewed

File without changes

{tests → clauseguard/tests}/test_risk_scorer.py RENAMED Viewed

File without changes

{tools → clauseguard/tools}/__init__.py RENAMED Viewed

File without changes

{tools → clauseguard/tools}/clause_tools.py RENAMED Viewed

File without changes

{tools → clauseguard/tools}/file_tools.py RENAMED Viewed

File without changes

{tools → clauseguard/tools}/report_tools.py RENAMED Viewed

File without changes