Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Aliroed examples image url fix #601

Merged
merged 2 commits into from
Sep 9, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions aliroed-examples/2_experiment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,35 @@
This guide shows you how to construct your own experiment, construct an AI experiment, and view and download results. It assumes that you have launched AliroEd in your Raspberry Pi.

1. **Introduction page** The first page you will see when AliroEd (in the Rapsberry Pi) launches is the introduction page. You can browse this site while AliroEd is loading.
![AliroEd Intropage](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/1_aliroed_intropage.png?raw=true "AliroEd Intropage")
<!-- ![AliroEd Intropage](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/1_aliroed_intropage.png?raw=true "AliroEd Intropage") -->
![AliroEd Intropage](https://raw.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/1_aliroed_intropage.png "AliroEd Intropage")

2. **Ready to Run** On the top-right corner of the introductory page you will see a message saying **Loading AliroEd**. Once AliroEd is loaded, this message will change to **Aliro is ready to run**. This is a link, click on it and will take you to the Aliro landing page (step 3).
![AliroEd Ready to Run](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/2_aliroed_readytorun.png?raw=true "AliroEd Ready to Run")
![AliroEd Ready to Run](https://raw.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/2_aliroed_readytorun.png?raw=true "AliroEd Ready to Run")

3. **Aliro landing page** This page shows you some preloaded datasets.
**Note the tooltips that will also guide you through buiding experiments.**
![AliroEd Landing Page](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/3_aliroed_landingpage.png?raw=true "AliroEd Landing Page")
![AliroEd Landing Page](https://raw.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/3_aliroed_landingpage.png?raw=true "AliroEd Landing Page")

4. **Building your own experiment** Click _Build New Experiment_ at the bottom of your dataset box.
This takes you to the experiment building page.
![AliroEd Building Experiment](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/4_aliroed_buildingownexperiment.png?raw=true "AliroEd Building Experiment")
![AliroEd Building Experiment](https://raw.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/4_aliroed_buildingownexperiment.png?raw=true "AliroEd Building Experiment")

5. **Experiments page** The Experiments page lists information about current experiments, including start time, score, and prediction type. By filtering by Algorithm, you can see the algorithm’s parameters for each experiment. In the Actions column on the right, you may download files to reproduce your results:
* **Download model** downloads a pickled model file that contains the trained model. Use it to run analysis on more datasets.

* **Download script** gives you a Python script to reproduce the analysis in the experiment.
![AliroEd Experiments Page](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/5_aliroed_experimentspage.png?raw=true "AliroEd Experiments Page")
![AliroEd Experiments Page](https://raw.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/5_aliroed_experimentspage.png?raw=true "AliroEd Experiments Page")

6. **Experiment results** The Results page summarizes the experiment results through figures and statistics. The algorithm configuration and runtime information is displayed on the left. On the right, the training and testing balances accuracies are shown. For every experiment, the top 10 most important features are shown in a bar plot on the bottom left. For every classification problem, a confusion matrix is shown. For binary classification, an ROC curve and AUC score is provided.
![AliroEd Experiment Results](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/6_aliroed_experimentresults.png?raw=true "AliroEd Experiments Results")
![AliroEd Experiment Results](https://raw.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/6_aliroed_experimentresults.png?raw=true "AliroEd Experiments Results")

7. **AI Analysis** To allow the AI to choose experiments for you, simply toggle on the AI button in the upper right corner of the dataset box. The AI will then run one or more experiments for which it chooses its own algorithms to run. Progress can be viewed from the Experiments page. To configure the AI settings (for example, the number of experiments to run or time limits), see the configuration file in config/ai.env.
![AliroEd AI Analysis](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/7_aliroed_ai.png?raw=true "AliroEd AI Analysis")
![AliroEd AI Analysis](https://raw.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/7_aliroed_ai.png?raw=true "AliroEd AI Analysis")

8. **Uploading your own dataset** Upload a dataset by clicking the "Add New Dataset" button on the **Aliro Landing Page**.
This will take you to the Dataset Upload screen where you can select a .csv or .tsv file to upload.
You will see a preview of the data.
Specify the name of the dependent column, as well as any nominal or ordinal features.
Some example datasets can be found in the [Penn Machine Learning Benchmarks github repository](https://epistasislab.github.io/pmlb)
![AliroEd Uploading Datasets](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/7_aliroed_ai.png?raw=true "AliroEd Uploading Datasets")
![AliroEd Uploading Datasets](https://raw.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/7_aliroed_ai.png?raw=true "AliroEd Uploading Datasets")