Zainab4626 commited on
Commit
f53dea8
·
1 Parent(s): ceb1aac

Add recruiter-friendly project README

Browse files
Files changed (1) hide show
  1. README.md +102 -0
README.md ADDED
@@ -0,0 +1,102 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # AI Engineering Portfolio
2
+
3
+ Applied AI and Generative AI project portfolio focused on practical implementation: retrieval-augmented generation (RAG), tool calling, prompt strategy, conversation memory, and interactive app workflows.
4
+
5
+ ## About This Repository
6
+
7
+ This repository documents hands-on AI engineering work through executable notebooks and supporting scripts. The goal is to demonstrate practical system design and implementation skills for real-world GenAI applications.
8
+
9
+ ## Core Skills Demonstrated
10
+
11
+ - LLM application development with OpenAI APIs
12
+ - Retrieval-Augmented Generation (RAG) pipelines
13
+ - Embeddings, chunking strategies, and semantic search setup
14
+ - Tool-calling and dynamic context orchestration patterns
15
+ - Prompt design and system-vs-user instruction control
16
+ - Conversational memory and context management
17
+ - Lightweight app prototyping with Gradio
18
+
19
+ ## Featured Work
20
+
21
+ ### RAG Implementation and Visualization
22
+ - `ai_env/Ai_Engineering_Part1/rag1.ipynb`
23
+ - Implements text chunking with overlap and boundary-aware splitting
24
+ - Generates embeddings (`text-embedding-3-small`)
25
+ - Visualizes semantic structure with 2D/3D t-SNE clustering
26
+ - Includes cluster-level interpretation output for explainability
27
+
28
+ ### Dynamic Context + Tool Calling Architecture
29
+ - `ai_env/Ai_Engineering_Part1/digital-twin-arch1-dynamic-context-toolcallingZ1.ipynb`
30
+ - `ai_env/Ai_Engineering_Part1/digital-twin-arch2-basic-tool-calling.ipynb`
31
+ - Explores architecture evolution from basic to dynamic tool-calling patterns
32
+ - Demonstrates practical context assembly for agent-like behavior
33
+
34
+ ### Prompting, Memory, and Agent Foundations
35
+ - `ai_env/Ai_Engineering_Part1/system-vs-user-prompt.ipynb`
36
+ - `ai_env/Ai_Engineering_Part1/conversation-history.ipynb`
37
+ - `ai_env/Ai_Engineering_Part1/tool_callling.ipynb`
38
+ - Focus on instruction hierarchy, session memory, and safe tool invocation
39
+
40
+ ### App and Workflow Prototypes
41
+ - `ai_env/Ai_Engineering_Part1/gradio.ipynb`
42
+ - `ai_env/Ai_Engineering_Part1/gradio_mcp_chat.py`
43
+ - `ai_env/Ai_Engineering_Part1/run_digital_twin_e2e.py`
44
+ - Demonstrates prototyping and basic end-to-end execution workflows
45
+
46
+ ## Tech Stack
47
+
48
+ - Python
49
+ - OpenAI API
50
+ - Jupyter Notebook
51
+ - NumPy, Matplotlib, scikit-learn
52
+ - Plotly
53
+ - Gradio
54
+ - python-dotenv
55
+
56
+ ## Quick Start
57
+
58
+ 1. Clone the repository
59
+ ```bash
60
+ git clone https://github.com/zainabahmed4626-lab/AI-Engineering.git
61
+ cd AI-Engineering
62
+ ```
63
+
64
+ 2. Create and activate a virtual environment
65
+ ```bash
66
+ python -m venv .venv
67
+ # Windows PowerShell
68
+ .venv\Scripts\Activate.ps1
69
+ ```
70
+
71
+ 3. Install dependencies
72
+ ```bash
73
+ pip install -r requirements.txt
74
+ pip install numpy matplotlib scikit-learn plotly nbconvert ipykernel
75
+ ```
76
+
77
+ 4. Configure environment variables
78
+ ```env
79
+ OPENAI_API_KEY=your_key_here
80
+ ```
81
+
82
+ 5. Launch notebooks
83
+ ```bash
84
+ jupyter notebook
85
+ ```
86
+
87
+ ## Project Structure
88
+
89
+ - `ai_env/Ai_Engineering_Part1/` — main notebook experiments and prototypes
90
+ - `requirements.txt` — base dependencies
91
+ - `.env` — local environment variables (not for commit)
92
+
93
+ ## Notes for Reviewers
94
+
95
+ - Notebooks are organized to show iterative engineering progress from fundamentals to architecture-level patterns.
96
+ - Several notebooks include execution-ready code and visualization output that can be run locally.
97
+ - This repo emphasizes implementation clarity and practical experimentation over framework-heavy abstractions.
98
+
99
+ ## Contact
100
+
101
+ - GitHub: [zainabahmed4626-lab](https://github.com/zainabahmed4626-lab)
102
+ - Portfolio/Contact: [resume-zainab.lovable.app](https://resume-zainab.lovable.app/#contact)