Aliroed examples

aliroed-examples/1_installation.md

@@ -0,0 +1,44 @@
+
+# AliroEd
+
+## AliroEd Installation Requirements
+- [Raspberry Pi 400](https://www.raspberrypi.com/products/raspberry-pi-400/)
+- A computer running Windows 10 or higher
+- A MicroSD Card Reader
+- MicroSD Card
+  - Minimum capacity: 32GB
+  - **Note:** There are different speed classes for MicroSD Cards, Application
+    Performance Class 1 (A1) and Application Performance 2 (A2). A2 cards are
+    **highly recommended** as these are much faster than A1 cards.
+- A copy of the [aliro-imager.exe](http://52.35.223.86/education/#download)
+
+## AliroEd Installation
+### Windows
+1. Download a copy of the [aliro-imager.exe](http://52.35.223.86/education/#download)
+2. Insert the MicroSD Card in your card reader.
+3. Double-click the downloaded **aliro-imager-\*.exe** on you computer. If prompted to allow
+   the application to run, select **Yes**. You may need to enter your computer's
+   **Administrator** password to continue.
+4. Follow the prompts to proceed with the installation.  
+   ![Aliro Imager Install](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_install.png?raw=true "Aliro Imager Install")
+5. Once installed, you can run the **AliroEd Imager** from the Start Menu. When
+   the program starts up you will see this screen:  
+    ![Aliro Imager Start](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_start.png?raw=true "Aliro Imager Start")
+6. Click the **CHOOSE STORAGE** button and select your MicroSD Card from the
+   popup menu.  
+    ![Aliro Imager Choose Storage](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_choose_storage.png?raw=true "Aliro Imager Choose Storage")
+7. Click the **WRITE** button to begin writing the Operatying System to your
+   MicroSD Card.  
+    ![Aliro Imager Write](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_write.png?raw=true "Aliro Imager Write") - **NOTE** that this will **format** your MicroSD Card and all existing data will
+   be erased. Click **Yes** at the prompt to proceed.  
+    ![Aliro Imager Format](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_format.png?raw=true "Aliro Imager Format") - This writing process may take several minutes, the progress will be shown
+   on the **AliroEd Imager.**  
+    ![Aliro Imager Finish](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_finish.png?raw=true "Aliro Imager Finish")
+8. Insert the MicroSD Card into your Raspberry Pi 400 and start it up.
+9. When the Operating System has finished starting up, double-click the
+   AliroEd Icon on the Destop or launch the Web Browser.
+
+Now that Aliro is up and running, you are ready to run experiments, AliroEd
+comes preloaded with some data sets for you to experiment with. Other datasets
+can be downloaded from the
+[Penn Machine Learning Benchmarks](https://github.com/EpistasisLab/pmlb)

aliroed-examples/2_experiment.md

@@ -0,0 +1,35 @@
+# Running experiments on AliroEd
+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")
+
+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")
+
+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")
+
+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")
+
+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")
+
+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")
+
+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")
+
+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")