diff --git a/templates/data-cleanse/README.md b/templates/data-cleanse/README.md new file mode 100644 index 0000000..8b15b4f --- /dev/null +++ b/templates/data-cleanse/README.md @@ -0,0 +1,97 @@ +# Data Cleanse Pro - Nosana Job Definition + +## Overview +Data Cleanse Pro is a web-based application for data cleaning, preprocessing, and machine learning model training. It provides users with a platform where they can obtain real performance metrics by utilizing their sample data to train specific machine learning models. This unique feature allows users to test various models—both for classification and regression tasks—using their actual datasets, thereby gaining valuable insights into model performance before committing to any particular approach. + +## Quick Start +To run the application using Nosana: + +```bash +nosana job post --file job-definition.json --market nvidia-3060 +``` + +Once deployed, the web interface will be available at the provided service URL. + +## Features +- **Data Cleaning & Preprocessing** + - Automatic data type detection (numeric vs categorical) + - Missing value handling (drop or fill) + - Feature normalization + - Categorical variable encoding + +- **Machine Learning Models** + - Classification Models: + - Logistic Regression + - Decision Tree + - Random Forest + - Support Vector Machine (SVM) + - K-Nearest Neighbors (KNN) + + - Regression Models: + - Linear Regression + - Gradient Boosting + - Support Vector Regression (SVR) + +- **Visualizations & Analysis** + - Feature correlation matrix + - Distribution plots for each feature + - Feature importance analysis + - Model performance metrics + - Confusion matrix (for classification) + - Actual vs Predicted plots (for regression) + +## Job Definition Details +The job is defined in `job-definition.json` with the following key components: + +- **Container Image**: `docker.io/acalculus/data_cleanse_app:latest` +- **Exposed Port**: 5000 (Web Interface) + +## Data Requirements +- Input: CSV files only +- Minimum rows: 10 +- Minimum columns: 2 numeric columns +- Target variable: Last column in the dataset + +## Model Selection Guidelines +### Classification Models +- **Logistic Regression**: Best for binary/multi-class outcomes with linear relationships +- **Decision Tree**: Good for mixed feature types and non-linear relationships +- **Random Forest**: Excellent for complex datasets with outliers +- **SVM**: Effective for high-dimensional data +- **KNN**: Best for well-defined group structures + +### Regression Models +- **Linear Regression**: Best for linear relationships +- **Gradient Boosting**: Powerful for complex non-linear relationships +- **SVR**: Good for non-linear relationships with kernel flexibility + +## Usage Instructions +1. Access the web interface at the provided service URL +2. Upload your CSV file +3. Select columns for cleaning and normalization +4. Choose between classification or regression +5. Select a specific model based on your data characteristics +6. Process the data and view results +7. Download cleaned data, trained model, or performance reports + +## Resource Requirements +- CPU: 1 core +- Memory: 2GB +- GPU: Not required +- Storage: Depends on dataset size + +## Docker Image +The application is containerized and available on Docker Hub: +```bash +docker pull acalculus/data_cleanse_app:latest +``` + +## Local Development +To run the application locally: +```bash +docker run -p 5000:5000 acalculus/data_cleanse_app:latest +``` +Access the application at http://localhost:5000 + +## Support +For issues or questions, please create an issue in the repository or contact the author. diff --git a/templates/data-cleanse/data-cleanse.mp4 b/templates/data-cleanse/data-cleanse.mp4 new file mode 100644 index 0000000..53eb1a0 Binary files /dev/null and b/templates/data-cleanse/data-cleanse.mp4 differ diff --git a/templates/data-cleanse/icon.png b/templates/data-cleanse/icon.png new file mode 100644 index 0000000..f534424 Binary files /dev/null and b/templates/data-cleanse/icon.png differ diff --git a/templates/data-cleanse/info.json b/templates/data-cleanse/info.json new file mode 100644 index 0000000..8a15ea7 --- /dev/null +++ b/templates/data-cleanse/info.json @@ -0,0 +1,9 @@ +{ + "id": "data-cleanse-web", + "name": "Data Cleanse Pro", + "description": "Data Class Pro is an innovative web-based platform designed to empower users in data cleaning and machine learning model evaluation. It provides users with a platform where they can obtain real performance metrics by utilizing their sample data to train specific machine learning models. This unique feature allows users to test various models—both for classification and regression tasks—using their actual datasets, thereby gaining valuable insights into model performance before committing to any particular approach.", + "category": ["API", "Web UI"], + "icon": "https://raw.githubusercontent.com/A-calculus/nosana-pipeline-templates/add-template-data-cleanse/templates/data-cleanse/icon.png", + "version": "1.0.0", + "author": "A-calculus" +} \ No newline at end of file diff --git a/templates/data-cleanse/job-definition.json b/templates/data-cleanse/job-definition.json new file mode 100644 index 0000000..7428d56 --- /dev/null +++ b/templates/data-cleanse/job-definition.json @@ -0,0 +1,21 @@ +{ + "version": "0.1", + "type": "container", + "meta": { + "trigger": "dashboard" + }, + "ops": [ + { + "type": "container/run", + "id": "data-cleanse-web", + "args": { + "cmd": ["python", "app.py"], + "image": "docker.io/acalculus/data_cleanse_app:latest", + "expose": 5000, + "env": { + "PYTHONUNBUFFERED": "1" + } + } + } + ] +} \ No newline at end of file