Soufianesejjari commited on
Commit
8fd59f5
Β·
1 Parent(s): f04673f

Update README.md to include project metadata, structure, license, and acknowledgements

Browse files
Files changed (1) hide show
  1. README.md +40 -0
README.md CHANGED
@@ -1,3 +1,16 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  # πŸš€ Resume Profile Extractor
2
 
3
  A powerful AI-powered application that automatically extracts professional profiles from resumes in PDF format. This application uses LLMs (via Groq) to intelligently parse resume content and generates structured profile data that can be used for portfolio generation, professional websites, and more.
@@ -103,3 +116,30 @@ The API is available at port 8000 when running locally, or through the Hugging F
103
 
104
  ## 🧩 Project Structure
105
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: Resume Profile Extractor
3
+ emoji: πŸ“„
4
+ colorFrom: blue
5
+ colorTo: green
6
+ sdk: docker
7
+ sdk_version: "20.10.7"
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
+
12
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
13
+
14
  # πŸš€ Resume Profile Extractor
15
 
16
  A powerful AI-powered application that automatically extracts professional profiles from resumes in PDF format. This application uses LLMs (via Groq) to intelligently parse resume content and generates structured profile data that can be used for portfolio generation, professional websites, and more.
 
116
 
117
  ## 🧩 Project Structure
118
 
119
+ ```
120
+ agentAi/
121
+ β”œβ”€β”€ agents/ # AI agents for extraction and processing
122
+ β”œβ”€β”€ services/ # Backend services (storage, etc.)
123
+ β”œβ”€β”€ utils/ # Utility functions
124
+ β”œβ”€β”€ app.py # Streamlit web application
125
+ β”œβ”€β”€ api.py # FastAPI endpoints
126
+ β”œβ”€β”€ models.py # Pydantic data models
127
+ β”œβ”€β”€ config.py # Application configuration
128
+ β”œβ”€β”€ run_combined.py # Script to run both services
129
+ β”œβ”€β”€ requirements.txt # Python dependencies
130
+ β”œβ”€β”€ Dockerfile # For containerized deployment
131
+ └── README.md # Documentation
132
+ ```
133
+
134
+ ## πŸ“ License
135
+
136
+ MIT License
137
+
138
+ ## πŸ™ Acknowledgements
139
+
140
+ - [Groq](https://groq.com) for the LLM API
141
+ - [Streamlit](https://streamlit.io) for the web framework
142
+ - [FastAPI](https://fastapi.tiangolo.com) for the API framework
143
+ - [LangChain](https://langchain.com) for LLM interactions
144
+ - [Hugging Face](https://huggingface.co) for hosting capabilities
145
+