Update README.md
Browse files
README.md
CHANGED
|
@@ -1,73 +1,6 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
## Features
|
| 9 |
-
|
| 10 |
-
- Resume upload (DOCX format)
|
| 11 |
-
- Job description input
|
| 12 |
-
- Quick and in-depth resume analysis
|
| 13 |
-
- Resume enhancement
|
| 14 |
-
- Output in multiple formats (DOCX, HTML)
|
| 15 |
-
|
| 16 |
-
## Architecture
|
| 17 |
-
|
| 18 |
-
The application follows this high-level flow:
|
| 19 |
-
|
| 20 |
-
1. Start Application
|
| 21 |
-
2. Upload DOCX Resume
|
| 22 |
-
3. Input Job Description
|
| 23 |
-
4. Input GROQ API Key
|
| 24 |
-
5. Choose Action (Analyze or Enhance)
|
| 25 |
-
6. If Analyze:
|
| 26 |
-
- Choose Analysis Type (Quick or In-Depth)
|
| 27 |
-
- Perform Analysis
|
| 28 |
-
- Display Results
|
| 29 |
-
7. If Enhance:
|
| 30 |
-
- Perform In-Depth Analysis
|
| 31 |
-
- Enhance Resume
|
| 32 |
-
- Generate Enhanced Outputs
|
| 33 |
-
|
| 34 |
-
## Key Components
|
| 35 |
-
|
| 36 |
-
- **Streamlit**: For the web interface
|
| 37 |
-
- **python-docx**: To process DOCX files
|
| 38 |
-
- **GROQ API**: For accessing AI models
|
| 39 |
-
- **LLaMA 3 70B**: Large language model for analysis and enhancement
|
| 40 |
-
- **Graphviz**: For generating the architecture diagram
|
| 41 |
-
|
| 42 |
-
## Setup and Installation
|
| 43 |
-
|
| 44 |
-
1. Clone the repository
|
| 45 |
-
2. Install required packages: `pip install - r requirements.txt`
|
| 46 |
-
3. Set up a GROQ API account and obtain an API key from here (https://console.groq.com/keys?_gl=1*1ozbol6*_gcl_au*MTc1ODk5MDQ0Mi4xNzM2NTgwNTgx*_ga*NDM2OTA5NjI1LjE3MzY1ODA1ODA.*_ga_4TD0X2GEZG*MTczNjU4MDU4MC4xLjAuMTczNjU4MDU4MC42MC4wLjA.)
|
| 47 |
-
|
| 48 |
-
## Usage
|
| 49 |
-
|
| 50 |
-
1. Run the Streamlit app: `streamlit run main.py`
|
| 51 |
-
2. Upload your resume (DOCX format)
|
| 52 |
-
3. Enter the job description
|
| 53 |
-
4. Provide your GROQ API key
|
| 54 |
-
5. Choose to analyze or enhance your resume
|
| 55 |
-
6. View the results or download the enhanced resume
|
| 56 |
-
|
| 57 |
-
## Modules
|
| 58 |
-
|
| 59 |
-
- `main.py`: Main Streamlit application
|
| 60 |
-
- `prompts.py`: Prompts for handling resume parsing and formatting
|
| 61 |
-
- `flowhchart.py`: Flow chart vizualization
|
| 62 |
-
|
| 63 |
-
## Dependencies
|
| 64 |
-
|
| 65 |
-
- Streamlit
|
| 66 |
-
- python-docx
|
| 67 |
-
- groq
|
| 68 |
-
- graphviz
|
| 69 |
-
- docx2txt
|
| 70 |
-
|
| 71 |
-
## Note
|
| 72 |
-
|
| 73 |
-
Ensure you have a valid GROQ API key and sufficient credits for using the LLaMA 3 70B model. The application's performance depends on the quality and availability of the AI model.
|
|
|
|
| 1 |
+
---
|
| 2 |
+
sdk: streamlit
|
| 3 |
+
colorFrom: yellow
|
| 4 |
+
colorTo: yellow
|
| 5 |
+
short_description: 'uses multiple agents to create your resume and CV '
|
| 6 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|