Al1Abdullah commited on
Commit
c6d58fd
·
1 Parent(s): 7e12ceb

Update README: Clarify project focus on CSV data for student demos and rename AI assistant

Browse files
Files changed (1) hide show
  1. README.md +5 -6
README.md CHANGED
@@ -2,14 +2,14 @@
2
 
3
  ## Overview
4
 
5
- This project is a comprehensive Automated Machine Learning (AutoML) platform designed to streamline the machine learning workflow from data preparation to model deployment. It integrates various functionalities including automated data cleaning, supervised and unsupervised learning model training, an AI-powered SQL assistant, and an interactive web-based frontend for user interaction and visualization.
6
 
7
  ## Features
8
 
9
  * **Automated Data Cleaning:** Utilities to preprocess and clean raw datasets, ensuring data quality for model training.
10
  * **Supervised Learning Models:** Implementation and integration of various supervised machine learning algorithms.
11
  * **Unsupervised Learning Models:** Support for unsupervised learning techniques for tasks like clustering and dimensionality reduction.
12
- * **AI SQL Assistant (Agentic Capability):** A Retrieval Augmented Generation (RAG) based AI assistant to help with SQL queries and database interactions. This component demonstrates agentic capabilities by intelligently processing natural language queries, retrieving relevant information, and generating actionable SQL.
13
  * **Interactive Web Frontend:** A user-friendly web interface built with HTML, CSS, and JavaScript for interacting with the AutoML functionalities and visualizing results.
14
  * **Data Visualization:** Tools to generate insightful charts and graphs from processed data and model outputs.
15
 
@@ -19,7 +19,6 @@ The project is organized into the following main directories:
19
 
20
  * `.env`: Environment variables, including API keys.
21
  * `app.py`: The main application entry point.
22
-
23
  * `config.py`: Configuration settings for the application.
24
  * `frontend/`: Contains the static files for the web-based user interface (HTML, CSS, JavaScript, images).
25
  * `models/`: Houses the implementations for supervised and unsupervised machine learning models.
@@ -80,12 +79,12 @@ To run the AutoML application:
80
  * **Python:** Core programming language.
81
  * **HTML, CSS, JavaScript:** For the frontend development.
82
  * **Git:** Version control.
83
- * **Groq API:** For AI-powered functionalities (e.g., SQL assistant).
84
  * **CatBoost:** (Implied by `catboost_info`) A machine learning library.
85
 
86
  ## Future Enhancements (Autonomous System Potential)
87
 
88
- The architecture of this project, particularly the RAG-based AI SQL Assistant, lays the groundwork for developing more autonomous capabilities. Future enhancements could involve integrating more complex decision-making processes, self-correction mechanisms, and broader task automation, moving towards a more fully autonomous AutoML system.
89
 
90
  ## Contributing
91
 
@@ -93,4 +92,4 @@ Contributions are welcome! Please feel free to fork the repository, create a new
93
 
94
  ## License
95
 
96
- This project is licensed under the MIT License. See the `LICENSE` file for more details (if applicable).
 
2
 
3
  ## Overview
4
 
5
+ This project is a comprehensive Automated Machine Learning (AutoML) platform designed to streamline the machine learning workflow for **CSV-formatted datasets**, particularly catering to students and researchers who need a rapid system for **demo sessions** in their data science and AI projects. It integrates various functionalities including automated data cleaning, supervised and unsupervised learning model training, an AI-powered data assistant, and an interactive web-based frontend for user interaction and visualization.
6
 
7
  ## Features
8
 
9
  * **Automated Data Cleaning:** Utilities to preprocess and clean raw datasets, ensuring data quality for model training.
10
  * **Supervised Learning Models:** Implementation and integration of various supervised machine learning algorithms.
11
  * **Unsupervised Learning Models:** Support for unsupervised learning techniques for tasks like clustering and dimensionality reduction.
12
+ * **AI Data Assistant (Agentic Capability):** A Retrieval Augmented Generation (RAG) based AI assistant designed to help users interact with and understand their **CSV datasets**. This component demonstrates agentic capabilities by intelligently processing natural language queries, retrieving relevant information from the dataset, and assisting with data exploration and analysis.
13
  * **Interactive Web Frontend:** A user-friendly web interface built with HTML, CSS, and JavaScript for interacting with the AutoML functionalities and visualizing results.
14
  * **Data Visualization:** Tools to generate insightful charts and graphs from processed data and model outputs.
15
 
 
19
 
20
  * `.env`: Environment variables, including API keys.
21
  * `app.py`: The main application entry point.
 
22
  * `config.py`: Configuration settings for the application.
23
  * `frontend/`: Contains the static files for the web-based user interface (HTML, CSS, JavaScript, images).
24
  * `models/`: Houses the implementations for supervised and unsupervised machine learning models.
 
79
  * **Python:** Core programming language.
80
  * **HTML, CSS, JavaScript:** For the frontend development.
81
  * **Git:** Version control.
82
+ * **Groq API:** For AI-powered functionalities (e.g., data assistant).
83
  * **CatBoost:** (Implied by `catboost_info`) A machine learning library.
84
 
85
  ## Future Enhancements (Autonomous System Potential)
86
 
87
+ The architecture of this project, particularly the RAG-based AI Data Assistant, lays the groundwork for developing more autonomous capabilities. Future enhancements could involve integrating more complex decision-making processes, self-correction mechanisms, and broader task automation, moving towards a more fully autonomous AutoML system.
88
 
89
  ## Contributing
90
 
 
92
 
93
  ## License
94
 
95
+ This project is licensed under the MIT License. See the `LICENSE` file for more details (if applicable).