ACA050 commited on
Commit
a820abc
·
verified ·
1 Parent(s): a309487

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +73 -62
README.md CHANGED
@@ -1,62 +1,73 @@
1
- # ModelSmith AI
2
-
3
- An intelligent ML platform that automates tabular classification and regression tasks. It analyzes datasets, recommends optimal strategies, trains models, and provides explanations.
4
-
5
- ## Features
6
-
7
- - **Dataset Analysis**: Automatic detection of data types, missing values, and potential issues
8
- - **Strategy Reasoning**: Intelligent model selection based on dataset characteristics
9
- - **Automated Training**: End-to-end model training with preprocessing pipelines
10
- - **Explainability**: SHAP-based feature importance explanations
11
- - **FastAPI Backend**: RESTful API for seamless integration
12
-
13
- ## Supported Scope
14
-
15
- - **Task**: Tabular classification and regression
16
- - **Input**: CSV files with ≥1200 rows
17
- - **Target**: Binary or multiclass classification, regression
18
- - **Features**: At least 2 usable features after preprocessing
19
-
20
- ## API Endpoints
21
-
22
- - `POST /analyze`: Analyze dataset and get strategy recommendations
23
- - `POST /train`: Train a model on the dataset
24
- - `POST /explain`: Get model explanations and feature importance
25
- - `POST /predict`: Make predictions with trained model
26
- - `GET /health`: Health check
27
-
28
- ## Deployment
29
-
30
- This project is designed for deployment on Hugging Face Spaces using Docker.
31
-
32
- ### Files for Deployment
33
-
34
- - `Dockerfile`
35
- - `requirements.txt`
36
- - `backend/` (entire directory)
37
-
38
- ### Running Locally
39
-
40
- ```bash
41
- pip install -r requirements.txt
42
- uvicorn backend.api.main:app --host 0.0.0.0 --port 7860
43
- ```
44
-
45
- ## Limitations
46
-
47
- - NLP functionality is disabled
48
- - Requires datasets with ≥1200 rows
49
- - CPU-only, no GPU support
50
- - Stateless API (models saved temporarily)
51
-
52
- ## Architecture
53
-
54
- - **Orchestrator**: Main workflow coordinator
55
- - **Dataset Analyzer**: Data profiling and preprocessing
56
- - **Strategy Reasoner**: Model selection logic
57
- - **Model Factory**: Training and evaluation
58
- - **Explainability Engine**: SHAP explanations
59
-
60
- ## License
61
-
62
- MIT License
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: ModelSmith AI
3
+ emoji: 🤖
4
+ colorFrom: blue
5
+ colorTo: green
6
+ sdk: gradio
7
+ sdk_version: "4.0.0"
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
+
12
+ # ModelSmith AI
13
+
14
+ An intelligent ML platform that automates tabular classification and regression tasks. It analyzes datasets, recommends optimal strategies, trains models, and provides explanations.
15
+
16
+ ## Features
17
+
18
+ - **Dataset Analysis**: Automatic detection of data types, missing values, and potential issues
19
+ - **Strategy Reasoning**: Intelligent model selection based on dataset characteristics
20
+ - **Automated Training**: End-to-end model training with preprocessing pipelines
21
+ - **Explainability**: SHAP-based feature importance explanations
22
+ - **FastAPI Backend**: RESTful API for seamless integration
23
+
24
+ ## Supported Scope
25
+
26
+ - **Task**: Tabular classification and regression
27
+ - **Input**: CSV files with ≥1200 rows
28
+ - **Target**: Binary or multiclass classification, regression
29
+ - **Features**: At least 2 usable features after preprocessing
30
+
31
+ ## API Endpoints
32
+
33
+ - `POST /analyze`: Analyze dataset and get strategy recommendations
34
+ - `POST /train`: Train a model on the dataset
35
+ - `POST /explain`: Get model explanations and feature importance
36
+ - `POST /predict`: Make predictions with trained model
37
+ - `GET /health`: Health check
38
+
39
+ ## Deployment
40
+
41
+ This project is designed for deployment on Hugging Face Spaces using Docker.
42
+
43
+ ### Files for Deployment
44
+
45
+ - `Dockerfile`
46
+ - `requirements.txt`
47
+ - `backend/` (entire directory)
48
+
49
+ ### Running Locally
50
+
51
+ ```bash
52
+ pip install -r requirements.txt
53
+ uvicorn backend.api.main:app --host 0.0.0.0 --port 7860
54
+ ```
55
+
56
+ ## Limitations
57
+
58
+ - NLP functionality is disabled
59
+ - Requires datasets with ≥1200 rows
60
+ - CPU-only, no GPU support
61
+ - Stateless API (models saved temporarily)
62
+
63
+ ## Architecture
64
+
65
+ - **Orchestrator**: Main workflow coordinator
66
+ - **Dataset Analyzer**: Data profiling and preprocessing
67
+ - **Strategy Reasoner**: Model selection logic
68
+ - **Model Factory**: Training and evaluation
69
+ - **Explainability Engine**: SHAP explanations
70
+
71
+ ## License
72
+
73
+ MIT License