hmnshudhmn24 commited on
Commit
88f96aa
·
verified ·
1 Parent(s): b91943a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +12 -2
README.md CHANGED
@@ -13,9 +13,19 @@ library_name: transformers
13
  base_model: Salesforce/codet5-small
14
  ---
15
 
16
- # code-explain-viz
 
17
 
18
- **Short:** `code-explain-viz` explains functions, generates step-by-step reasoning, creates a Mermaid flowchart of control flow, and suggests unit tests combining LLM-generated explanations with deterministic AST-based visualizations.
 
 
 
 
 
 
 
 
 
19
 
20
  ## Quick start
21
 
 
13
  base_model: Salesforce/codet5-small
14
  ---
15
 
16
+ 🧠 CODE-EXPLAIN-VIZ: AI-Powered Code Understanding & Visualization
17
+ ✨ Project Description
18
 
19
+ CODE-EXPLAIN-VIZ is an advanced AI-driven code comprehension and visualization system designed to explain source code in natural language and generate visual flow diagrams automatically.
20
+ Built on top of CodeT5, this model reads raw Python code and produces a detailed explanation, step-by-step logic breakdown, and a Mermaid flowchart that represents the control flow of the program.
21
+
22
+ It’s the perfect assistant for developers, educators, and students who want to:
23
+
24
+ Understand unfamiliar code instantly 🧩
25
+
26
+ Generate documentation and flowcharts automatically 📘
27
+
28
+ Visualize logic structure and data flow in seconds ⚙️
29
 
30
  ## Quick start
31