ranilmukesh commited on
Commit
8ccb2de
·
1 Parent(s): 785d931

Enhance README.md with detailed descriptions, features, tech stack, usage instructions, and SEO keywords

Browse files
Files changed (1) hide show
  1. README.md +73 -3
README.md CHANGED
@@ -12,11 +12,12 @@ short_description: AI placement prediction and career routing.
12
 
13
  # PlacementPredictor+ | AI Career Router
14
 
15
- Advanced machine learning with real-time explainable insights for personalized career path routing.
 
16
 
17
  ## Features
18
- - **XGBoost Prediction**: High accuracy placement probability.
19
- - **SHAP Explainability**: Understand the "why" behind your result.
20
  - **Career Routing**: Knowledge graph-based skill gap analysis.
21
  - **AI Career Assistant**: Natural language chat for personalized guidance.
22
 
@@ -28,3 +29,72 @@ python main.py
28
 
29
  ## Deployment
30
  Running on Hugging Face Spaces via Docker.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
 
13
  # PlacementPredictor+ | AI Career Router
14
 
15
+ Advanced machine learning with real-time explainable insights for personalized career path routing. This campus placement AI app acts as a placement predictor and AI career router, giving students and graduates a realistic assessment of job prospects based on CGPA, internships, and skill sets.
16
+
17
 
18
  ## Features
19
+ - **XGBoost Prediction**: High accuracy placement probability powered by the best in campus placement AI and job skills analysis.
20
+ - **SHAP Explainability**: Understand the "why" behind your result and gain clarity on factors affecting your placement chances.
21
  - **Career Routing**: Knowledge graph-based skill gap analysis.
22
  - **AI Career Assistant**: Natural language chat for personalized guidance.
23
 
 
29
 
30
  ## Deployment
31
  Running on Hugging Face Spaces via Docker.
32
+
33
+ ## Table of Contents
34
+ 1. [Overview](#overview)
35
+ 2. [Features](#features)
36
+ 3. [Tech Stack](#tech-stack)
37
+ 4. [Local Setup](#local-setup)
38
+ 5. [Usage](#usage)
39
+ - [Web Interface](#web-interface)
40
+ - [API Endpoints](#api-endpoints)
41
+ 6. [Deployment](#deployment)
42
+ 7. [Development](#development)
43
+ 8. [Contributing](#contributing)
44
+ 9. [License](#license)
45
+ 10. [Contact & Support](#contact--support)
46
+
47
+ ## Overview
48
+ PlacementPredictor+ is an open‑source, AI-driven placement predictor and career guidance tool designed specifically for college students and fresh graduates in India and beyond. This geo‑aware education AI leverages campus placement AI methodologies to estimate chances of securing jobs and internships. By blending predictive modeling, explainable AI, and a knowledge graph, it routes users toward suitable roles while highlighting skill gaps.
49
+
50
+
51
+ ## Tech Stack
52
+ - **Backend**: FastAPI (Python)
53
+ - **Modeling**: XGBoost, SHAP for explanation, scikit-learn utilities
54
+ - **Routing Engine**: Custom NetworkX knowledge graph
55
+ - **Frontend**: Vanilla JavaScript, HTML5, CSS3
56
+ - **LLM Chat**: NVIDIA AGNO SDK (Llama/Minimax)
57
+ - **Deployment**: Docker, Hugging Face Spaces (port 7860)
58
+
59
+ ## Usage
60
+
61
+ PlacementPredictor+ is optimized for SEO with keywords such as placement predictor, AI career router, job skills analysis, and education AI appearing throughout this document.
62
+ ### Web Interface
63
+ 1. Start the backend:
64
+ ```bash
65
+ pip install -r requirements.txt
66
+ python main.py
67
+ ```
68
+ 2. Open a browser and navigate to `http://localhost:7860` (or the port configured in your environment).
69
+ 3. Fill in your details, add existing skills, and optionally select a desired job role. Submit to view placement probability, factor explanations, recommended job, missing skills, and an interactive career path chart.
70
+
71
+ ### API Endpoints
72
+ All endpoints return JSON and can be consumed programmatically.
73
+
74
+ | Path | Method | Description |
75
+ |------|--------|-------------|
76
+ | `/health` | GET | Check service health and model availability |
77
+ | `/options` | GET | Retrieve available streams, skills, and job roles |
78
+ | `/predict` | POST | Get placement prediction & recommendations (see `StudentData` schema) |
79
+ | `/explain` | POST | Obtain SHAP-based explanation for a prediction |
80
+ | `/whatif` | POST | Run hypothetical scenarios (increase CGPA, internships, clear backlogs) |
81
+
82
+ Use the `StudentData` Pydantic model schema from the backend as reference for payload structure.
83
+
84
+ ## Development
85
+ - Artifacts (trained model, encoders, routing graph) are stored in `placement_artifacts.pkl`.
86
+ - To retrain, run `python train_model.py` and ensure `requirements.txt` contains needed libraries (e.g., `networkx`, `matplotlib`).
87
+ - Frontend assets live in the project root and are served statically by FastAPI when running in production.
88
+
89
+ ## Contributing
90
+ 1. Fork the repository and create a feature branch.
91
+ 2. Make your changes and add tests where appropriate.
92
+ 3. Open a pull request detailing the enhancement or bug fix.
93
+
94
+ Please follow standard GitHub flow and ensure your code passes linting/formatting rules. Issues and feature requests are welcome.
95
+
96
+ ## License
97
+ This project is released under the [MIT License](LICENSE).
98
+
99
+
100
+ <!-- Hidden SEO keywords: placement predictor, AI career router, campus placement AI, job skills analysis, career guidance tool, XGBoost placement, SHAP explainability, education AI, student job forecasting, vocational guidance AI, placement probability calculator, career planning AI, personalized job recommendations, skill gap analysis, placement assistance, geo-targeted career tool, seo friendly placement app, aeo optimization, geo-specific education technology -->