Skip to content

Latest commit

 

History

History
85 lines (67 loc) · 4.41 KB

README.md

File metadata and controls

85 lines (67 loc) · 4.41 KB

DashAI

Open Source? Yes! Open Source? Yes! Maintenance Maintenance made-with-python Documentation Status Documentation Status

Installation

To install, just run the following commands in order.

1. Clone our Repo

git clone https://github.com/manikyabard/DashAI.git

2. cd into our Repo

cd DashAI/

3. Install the Dependencies

chmod +x install.sh && ./install.sh

4. Activate the environment

conda activate server

5. Run the server

⚠️ from DashAI folder

mkdir -p ~/.dashai && python -u worker/app/app.py > ~/.dashai/result.txt

6. Install the application

Install App by clicking on DashAI/app/dist/DashAI.dmg

7. Start the application from your launcher

Quick Start

Complete the installation steps as shown above. To start using DashAI, open a terminal window and type in the following command.

dashai

This will start a server and run the app. See Working for next steps.

Working

Step 1: Choosing the task.

You first get to choose the type of application you want to create a model for. DashAI uses this information in later stages, to suggest architectures that have achieved state-of-the-art results in that task. You can choose one of four tasks: collaborative filtering, tabular, text, and vision.

Step 2: Selecting the dataset.

You then provide DashAI the dataset you intend to use, and let DashAI know how to utilize the dataset best. DashAI then asks how to split the dataset (into training and validation sets), how to label it, and what transforms to apply on the dataset.

Step 3: Selecting the model.

You then have to choose what architecture they want your model to have. DashAI provides architectures that have achieved state-of-the-art results in the task defined, but you may use any model built using PyTorch layers.

Step 4: (Optional) Auto ML

At this point, you may choose one of three options:

  • to use DashAI default hyper-parameters;
  • to input hyper-parameter values of your choosing; or
  • to use DashAI's auto ML component, Verum, to select the best possible hyper-parameter values. In Verum, you may choose which hyper-parameters you want tuned, the number of experiments to be run, and whether the resulting values should automatically be applied to the model.

Step 5: (Optional) Training the model.

DashAI then provides a simple training interface, where, if you have not chosen to utilize Verum's automatic applying feature, you may input the hyper-parameter values required for training. You can also pick between generic training and 1-cycle training.

Step 6: (Optional) Explainability

You can then choose to visualize the attributions in the explainability component of DashAI, DashInsights. You may choose from a multitude of attribution-calculation algorithms, depending on your task. The visualizations can provide insight into why a model is predicting what it is predicting.

Step 7: (Optional) Saving the model.

Finally, you can save your models as .pth files. We provide instructions on how to use these files in the Deployment section of our Wiki.

More Info

Check out our Wiki!

Copyright

Copyright © 2020 onward
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project's files except in compliance with the License. A copy of the License is provided in the LICENSE file in this repository.