Skip to content

Commit 883315e

Browse files
authored
Add web app generation section to README
Added section on generating web apps for trained models using Mercury, including code examples and features of the generated app.
1 parent 83def58 commit 883315e

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Start quickly, iterate faster, and manage experiments in one place.
4444
## Table of Contents
4545

4646
- [Automated Machine Learning](https://github.com/mljar/mljar-supervised#automated-machine-learning)
47+
- [Generate Web Apps for Trained Models](https://github.com/mljar/mljar-supervised#generate-web-apps-for-trained-models)
4748
- [What's good in it?](https://github.com/mljar/mljar-supervised#whats-good-in-it)
4849
- [Automatic Documentation](https://github.com/mljar/mljar-supervised#automatic-documentation)
4950
- [Available Modes](https://github.com/mljar/mljar-supervised#available-modes)
@@ -71,6 +72,7 @@ The `mljar-supervised` will help you with:
7172
- explaining and understanding your data through model reports, feature importance, and SHAP explanations,
7273
- trying many different machine learning models (Algorithm Selection and Hyper-Parameters tuning),
7374
- creating Markdown reports from analysis with details about all models (Automatic-Documentation),
75+
- generating a web app for a trained model, so predictions can be used by domain experts,
7476
- saving, re-running, and loading the analysis and ML models.
7577

7678
It has four built-in modes of work:
@@ -81,6 +83,45 @@ It has four built-in modes of work:
8183

8284
Of course, you can further customize the details of each `mode` to meet the requirements.
8385

86+
## Generate Web Apps for Trained Models
87+
88+
MLJAR AutoML does not stop after training a model. It can automatically generate a web app for your trained model with [Mercury](https://github.com/mljar/mercury). This is useful when you want to share predictions with domain experts, business users, researchers, or other people who do not want to work directly with Python code.
89+
90+
After training AutoML, generate the app files with:
91+
92+
```python
93+
from supervised import AutoML
94+
# AutoML training
95+
automl = AutoML(results_path="AutoML")
96+
automl.fit(X, y)
97+
98+
# Generate a Mercury web app for the trained model
99+
automl.app()
100+
```
101+
102+
You can also start the app locally:
103+
104+
```python
105+
automl.local_app()
106+
```
107+
108+
or publish it quickly:
109+
110+
```python
111+
automl.publish_app()
112+
```
113+
114+
The generated app can include:
115+
- single prediction dashboard,
116+
- batch prediction from CSV files,
117+
- downloadable predictions,
118+
- feature importance plots,
119+
- feature context plots for single predictions.
120+
121+
With this feature, you can go from: CSV data -> trained ML model -> ready-to-use prediction web app.
122+
123+
Please check the [Apps documentation](https://supervised.mljar.com/features/apps/) for details.
124+
84125
## What's good in it?
85126

86127
- It uses many algorithms: `Baseline`, `Linear`, `Random Forest`, `Extra Trees`, `LightGBM`, `Xgboost`, `CatBoost`, `Neural Networks`, and `Nearest Neighbors`.

0 commit comments

Comments
 (0)