Omar10lfc commited on
Commit
535617a
·
verified ·
1 Parent(s): 17d014b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -6
README.md CHANGED
@@ -10,13 +10,9 @@ pinned: false
10
  ---
11
  # Self-Refining Resume Optimizer Agent
12
 
13
- An intelligent, multi-agent system built with **LangGraph**, **Llama 3**, and **Gradio** that autonomously refines resumes. Unlike standard tools, this agent scans for gaps, asks for human input, and iteratively critiques its own work until it hits a quality threshold.
14
-
15
- ![Architecture Diagram](agent_diagram.png)
16
-
17
  ## Project Overview
18
 
19
- This project implements a sophisticated **Agentic Workflow** that mimics a professional writer/editor relationship. It goes beyond simple text generation by introducing state management and user feedback loops.
20
 
21
  ### Key Features
22
 
@@ -24,6 +20,7 @@ This project implements a sophisticated **Agentic Workflow** that mimics a profe
24
  * **Gap Analysis:** Identifies exactly which skills (e.g., "SQL", "CI/CD") are missing from your profile.
25
  * **Human-in-the-Loop:** Pauses the workflow to ask you for context (e.g., *"You are missing SQL. Do you have this experience?"*) before writing.
26
  * **Self-Refinement:** A "Critic" node scores every draft (0-100). If the score is low, the "Writer" node must rewrite it.
 
27
 
28
  ## Tech Stack
29
 
@@ -32,10 +29,13 @@ This project implements a sophisticated **Agentic Workflow** that mimics a profe
32
  * **Interface:** **Gradio** (Web UI for PDF uploads and interactive feedback).
33
  * **Data Processing:** `PyPDF` (Document Parsing) & `WebBaseLoader` (Scraping).
34
  * **Validation:** Pydantic (Structured Output).
 
35
 
36
  ## How It Works (The Graph)
37
 
38
- The system is modeled as a State Graph with a specific 2-step execution flow:
 
 
39
 
40
  | Node | Role | Behavior |
41
  |------|------|----------|
@@ -44,6 +44,8 @@ The system is modeled as a State Graph with a specific 2-step execution flow:
44
  | **Human Loop** | Manager | **Stops execution** to let the user add context/experience for the missing skills. |
45
  | **Improver** | Writer | Rephrases the resume using the user's notes. **Constraint:** Never hallucinates experience. |
46
  | **Reviewer** | Judge | Acts as a Hiring Manager. Returns a `Score` (0-100) and specific `Feedback`. |
 
 
47
 
48
  ### The "Loop" Logic
49
 
 
10
  ---
11
  # Self-Refining Resume Optimizer Agent
12
 
 
 
 
 
13
  ## Project Overview
14
 
15
+ This project implements a sophisticated **Agentic Workflow** that mimics a professional writer/editor relationship. It goes beyond simple text generation by introducing state management, user feedback loops, and automated document formatting.
16
 
17
  ### Key Features
18
 
 
20
  * **Gap Analysis:** Identifies exactly which skills (e.g., "SQL", "CI/CD") are missing from your profile.
21
  * **Human-in-the-Loop:** Pauses the workflow to ask you for context (e.g., *"You are missing SQL. Do you have this experience?"*) before writing.
22
  * **Self-Refinement:** A "Critic" node scores every draft (0-100). If the score is low, the "Writer" node must rewrite it.
23
+ * **Professional Outputs:** Automatically generates a **tailored Cover Letter** and exports both documents as CSS-styled **PDFs**.
24
 
25
  ## Tech Stack
26
 
 
29
  * **Interface:** **Gradio** (Web UI for PDF uploads and interactive feedback).
30
  * **Data Processing:** `PyPDF` (Document Parsing) & `WebBaseLoader` (Scraping).
31
  * **Validation:** Pydantic (Structured Output).
32
+ * **Output Engine:** `markdown`& `xhtml2pdf` (Rendering CSS-styled documents).
33
 
34
  ## How It Works (The Graph)
35
 
36
+ ![Architecture Diagram](agent_diagram.png)
37
+
38
+ The system is modeled as a State Graph with a specific multi-stage execution flow::
39
 
40
  | Node | Role | Behavior |
41
  |------|------|----------|
 
44
  | **Human Loop** | Manager | **Stops execution** to let the user add context/experience for the missing skills. |
45
  | **Improver** | Writer | Rephrases the resume using the user's notes. **Constraint:** Never hallucinates experience. |
46
  | **Reviewer** | Judge | Acts as a Hiring Manager. Returns a `Score` (0-100) and specific `Feedback`. |
47
+ | **Cover Letter**| Author | Uses the finalized resume and job text to write a cohesive cover letter. |
48
+ | **PDF Exporter**| Publisher| Renders the final Markdown text into professional PDFs with custom styling. |
49
 
50
  ### The "Loop" Logic
51