Spaces:
Runtime error
Runtime error
Initialize README with project details and instructions
Browse filesAdd detailed project description, features, installation instructions, and future improvements.
README.md
ADDED
|
@@ -0,0 +1,111 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# AI Workflow Analyzer
|
| 2 |
+
|
| 3 |
+
An AI-powered tool that analyzes workflows, identifies inefficiencies, and suggests automation opportunities using Large Language Models.
|
| 4 |
+
|
| 5 |
+
|
| 6 |
+
## Overview
|
| 7 |
+
|
| 8 |
+
This project helps teams understand and improve their internal processes by leveraging AI. Users can input a workflow description, and the system returns a structured analysis including problems, automation opportunities, and AI-driven solutions.
|
| 9 |
+
|
| 10 |
+
|
| 11 |
+
## Features
|
| 12 |
+
|
| 13 |
+
- Analyze workflows in real time
|
| 14 |
+
- Identify inefficiencies and bottlenecks
|
| 15 |
+
- Suggest AI-based automation strategies
|
| 16 |
+
- Generate prototype ideas for implementation
|
| 17 |
+
- Export analysis as a Markdown (.md) file
|
| 18 |
+
- Simple and interactive UI using Streamlit
|
| 19 |
+
|
| 20 |
+
|
| 21 |
+
## Demo
|
| 22 |
+
[Live demo]()
|
| 23 |
+
|
| 24 |
+
Users can:
|
| 25 |
+
1. Enter a workflow description
|
| 26 |
+
2. Receive structured AI analysis
|
| 27 |
+
3. Download the results as a Markdown report
|
| 28 |
+
|
| 29 |
+
|
| 30 |
+
## Example Input
|
| 31 |
+
|
| 32 |
+
- Our engineering team manually reviews logs and writes daily summaries. This process is slow and inconsistent.
|
| 33 |
+
|
| 34 |
+
|
| 35 |
+
## Example Output
|
| 36 |
+
|
| 37 |
+
- **Problems**
|
| 38 |
+
- Manual and repetitive work
|
| 39 |
+
- Time-consuming process
|
| 40 |
+
- Inconsistent results
|
| 41 |
+
|
| 42 |
+
- **Automation Opportunities**
|
| 43 |
+
- Automate log summarization
|
| 44 |
+
- Standardize reporting
|
| 45 |
+
|
| 46 |
+
- **AI Solution**
|
| 47 |
+
- Use an LLM to extract key insights and generate summaries
|
| 48 |
+
|
| 49 |
+
- **Prototype Idea**
|
| 50 |
+
- Python script that processes logs and generates summaries using an AI API
|
| 51 |
+
|
| 52 |
+
|
| 53 |
+
## Tech Stack
|
| 54 |
+
|
| 55 |
+
- Python
|
| 56 |
+
- Streamlit
|
| 57 |
+
- Google Gemini API (LLM)
|
| 58 |
+
|
| 59 |
+
|
| 60 |
+
## Project Structure
|
| 61 |
+
```
|
| 62 |
+
src/
|
| 63 |
+
βββ main.py
|
| 64 |
+
βββ analyzer.py
|
| 65 |
+
βββ prompts.py
|
| 66 |
+
```
|
| 67 |
+
|
| 68 |
+
|
| 69 |
+
## Installation
|
| 70 |
+
|
| 71 |
+
```bash
|
| 72 |
+
git clone https://github.com/YamenRM/workflow-analyzer.git
|
| 73 |
+
cd workflow-analyzer
|
| 74 |
+
pip install -r requirements.txt
|
| 75 |
+
```
|
| 76 |
+
|
| 77 |
+
## Setup
|
| 78 |
+
Set your API key as an environment variable:
|
| 79 |
+
- Windows (PowerShell)
|
| 80 |
+
```
|
| 81 |
+
setx GEMINI_API_KEY "your_api_key_here"
|
| 82 |
+
```
|
| 83 |
+
|
| 84 |
+
- Linux / macOS
|
| 85 |
+
```
|
| 86 |
+
export GEMINI_API_KEY="your_api_key_here"
|
| 87 |
+
```
|
| 88 |
+
|
| 89 |
+
### Run the App
|
| 90 |
+
```
|
| 91 |
+
streamlit run main.py
|
| 92 |
+
```
|
| 93 |
+
|
| 94 |
+
## Use Cases
|
| 95 |
+
- Engineering workflow optimization
|
| 96 |
+
- AI adoption analysis
|
| 97 |
+
- Process automation planning
|
| 98 |
+
- Internal tooling prototyping
|
| 99 |
+
|
| 100 |
+
|
| 101 |
+
## Future Improvements
|
| 102 |
+
- Structured JSON output
|
| 103 |
+
- Workflow visualization (diagrams)
|
| 104 |
+
- History tracking of analyses
|
| 105 |
+
- Multi-workflow comparison
|
| 106 |
+
- Integration with team tools (e.g., GitLab, Notion)
|
| 107 |
+
|
| 108 |
+
|
| 109 |
+
##Author
|
| 110 |
+
|
| 111 |
+
**YamenRM**
|