milosz-l / dartml

DartML: Machine Learning for Everyone (AutoML app for supervised learning on tabular data)

🎯 DartML

Welcome to DartML: Machine Learning for Everyone! This app lets you build Machine Learning models without writing a single line of code.

• Step 1: Upload your data
  • Specify sample size
  • Choose between train/test split and cross validation
  • Define shuffle and stratify options
• Step 2: Explore the data
  • Numerical data exploration
  • Categorical data exploration
• Step 3: Build the model
  • Choose the target column
  • Select the problem type (can be also automatically detected)
  • Define metric (e.g. accuracy, f1 score, etc.)
  • Choose algorithms
  • Specify total training time
• Step 4: Evaluate the trained models
  • NOTE: All the tables and plots shown below are being updated in real time during the training!
  • Leaderboard
  • Performance Boxplot
  • Features Importance (eXplainable AI)
  • Spearman Correlation of Models
  • Logs
• At last, you can download report with all trained models and more detailed information about them (e.g. SHAP or dtreeviz visualizations).
  • SHAP values for 10 worst predictions
  • dtreeviz visualization

Demo video

Click above to watch the demo!

How to install and run the app

Install requirements

Using pip

pip install -r requirements.txt

Using conda

You can change new_env_name to any name you like.

conda create --name new_env_name python=3.9
conda activate new_env_name
pip install -r requirements.txt

Run the app

streamlit run 0_🏠_Home.py

Project structure

.
├── 0_🏠_Home.py                    # Home page streamlit view.
├── pages                           # Streamlit views for other pages of the app.
│   ├── 1_🧪_Sample.py              # Sample page streamlit view.
│   ├── 2_🔍_Explore.py             # Explore page streamlit view.
│   ├── 4_🛠️_Modify_&_Model.py      # Modify & Model page streamlit view.
│   └── 5_📊_Assess.py              # Assess page streamlit view.
├── src                             # Source code of the app.
│   ├── config.py                   # Configurations for the app.
│   ├── sample                      # Code used specifically in the Sample page.
│   ├── explore                     # Code used specifically in the Explore page.
│   ├── modify_and_model            # Code used specifically in the Modify & Model page.
│   ├── assess                      # Code used specifically in the Assess page.
│   ├── general_views               # Smaller streamlit views used in multiple pages.
│   └── session_state               # Functions related to handling app's session state.
├── tests                           # Tests for the app.
│   ├── functional_tests            # Functional tests.
│   └── load_tests                  # Load tests.
│   └── unit_tests                  # Unit tests.
├── temp_dirs                       # Temporary directories used to store training results.
│   └── .gitkeep                    # Empty file to make sure the directory is tracked by git.
├── docs                            # Documentation for the app.
├── example_data                    # Example data used in the app.
├── README.md                       # project description you are reading right now
├── .pre-commit-config.yaml         # pre-commit configuration
├── .flake8                         # flake8 configuration (run by pre-commit)
├── .isort.cfg                      # isort configuration (run by pre-commit)
├── requirements.txt                # dependencies for pip
└── .streamlit                      # configurations for streamlit (theme)
    └── config.toml                 # configurations for streamlit (theme)

Testing

Load tests

• These tests check how app behaves under heavy load.
• Used package: locust.

Run simple load tests

Perform simple load test by just visiting pages without interacting with any buttons or uploading any files.

locust -f tests/load_tests/simple_load_tests.py

Remember to put Host information without backlash at the end, for example:

• http://localhost:8501 <- this is correct
• http://localhost:8501/ <- this is incorrect

You can start the locust and simultaneously use the app yourself (or run functional tests), so you can see how the response time changes and ensure that there are no failures.

Functional tests

• These tests check whether app visually looks and behaves as expected.
• Used package: seleniumbase.

Run functional tests

First you need to specify the HOST_URL in tests/functional_tests/config.py file. By default it's set to http://localhost:8501.

Run all tests:

pytest tests/functional_tests/functional_tests.py --chrome --headless

Run single test (test_explore_page in this example):

pytest tests/functional_tests/functional_tests.py --chrome --headless -k test_explore_page

• You can specify the number of concurrent users by adding -n=<number_of_users> flag.
• You can remove the --headless flag if you want to make the testing browser visible.
• You can change --edge to any browser you like, for example --chrome or --firefox.
• You can make it slower by adding --slow flag.
• You can highlight assertions by adding --demo flag.
• You can add -k <test_name> flag to run only specific test.

Unit tests

• These tests check whether individual functions work as expected.

Run unit tests

pytest tests/unit_tests

Generate documentation from docstrings

using doxygen

doxygen

using pdoc

pdoc src

pre-commit

Install the pre-commit Git hook to run it automatically before each commit

pre-commit install

Manually run autoformat and code quality check

pre-commit run --all-files

Command above runs the following:

1. black - general code autoformatting
2. flake8 - code quality check
3. isort - imports autoformatting (alphabetical order)
4. interrogate - check code for missing docstrings