Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,62 +1,73 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
- **
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
- `
|
| 35 |
-
- `
|
| 36 |
-
- `
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
-
|
| 59 |
-
|
| 60 |
-
|
| 61 |
-
|
| 62 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 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
|