Skip to content

Commit

Permalink
Merge pull request #542 from jay-m-dev/master
Browse files Browse the repository at this point in the history
updated docs screenshot links
  • Loading branch information
jay-m-dev authored Jan 16, 2023
2 parents 27774f7 + b130723 commit 3d4040e
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 13 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ data/recommenders/scikitlearn/KNNWithMeansRecommender_classifier_accuracy_pmlb.p
data/recommenders/scikitlearn/SVDRecommender_classifier_accuracy_pmlb.pkl.gz filter=lfs diff=lfs merge=lfs -text
data/recommenders/scikitlearn/SVDRecommender_regressor_nmse_pmlb.pkl.gz filter=lfs diff=lfs merge=lfs -text
data/recommenders/scikitlearn/SlopeOneRecommender_classifier_accuracy_pmlb.pkl.gz filter=lfs diff=lfs merge=lfs -text

docs/source/_static/*.png filter=lfs diff=lfs merge=lfs -text
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- [![Logo](./docs/source/_static/logo_blank_small.png)]() -->

[![Logo](./docs/source/_static/aliro_brain_logo.png)]()
[![Logo](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/aliro_brain_logo.png)]()

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://github.com/EpistasisLab/Aliro/blob/master/LICENSE)
[![Aliro CI/CD](https://github.com/EpistasisLab/Aliro/actions/workflows/aliro_tests.yml/badge.svg)](https://github.com/EpistasisLab/Aliro/actions/workflows/aliro_tests.yml)
Expand Down
12 changes: 6 additions & 6 deletions docs/guides/userGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,18 @@ We have built a custom Raspberry Pi OS Image containing Aliro (configured to be
1. Insert the MicroSD Card in your card reader.
2. Double-click the **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.
3. Follow the prompts to proceed with the installation.
![Aliro Imager Install](https://raw.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_install.png?raw=true "Aliro Imager Install")
![Aliro Imager Install](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_install.png?raw=true "Aliro Imager Install")
4. 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://raw.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_start.png?raw=true "Aliro Imager Start")
![Aliro_Imager_Start](https://media.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_start.png?raw=true "Aliro Imager Start")
5. Click the **CHOOSE STORAGE** button and select your MicroSD Card from the popup menu.
![Aliro Imager Choose Storage](https://raw.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_choose_storage.png?raw=true "Aliro Imager Choose Storage")
![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")
6. Click the **WRITE** button to begin writing the Operatying System to your MicroSD Card.
![Aliro Imager Write](https://raw.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_write.png?raw=true "Aliro Imager Write")
![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://raw.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_format.png?raw=true "Aliro Imager Format")
![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://raw.githubusercontent.com/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_finish.png?raw=true "Aliro Imager Finish")
![Aliro Imager Finish](https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/aliro_imager_finish.png?raw=true "Aliro Imager Finish")

7. Insert the MicroSD Card into your Raspberry Pi 400 and start it up.
8. When the Operating System has finished starting up, double-click the Aliro-Ed Icon on the Destop or launch the Web Browser.
Expand Down
12 changes: 6 additions & 6 deletions docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Analysis Quickstart
This guide shows you how to construct your own experiment, construct an AI experiment, and view and download results.
It assumes you have already installed Aliro (see :ref:`user-guide`).

.. image:: _static/landing_page.png
.. image:: https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/landing_page.png
:width: 400
:alt: Dataset elements on the landing page.
:align: center
Expand All @@ -18,7 +18,7 @@ Click on the name of the dataset to see information about it, including a data p
Uploading a dataset
===================

.. image:: _static/dataset_upload.png
.. image:: https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/dataset_upload.png
:width: 600
:alt: Dataset Upload.
:align: center
Expand All @@ -37,7 +37,7 @@ Building your own experiment
Click `Build New Experiment` at the bottom of your dataset box.
This takes you to the experiment building page.

.. image:: _static/build_experiment.png
.. image:: https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/build_experiment.png
:width: 600
:alt: Experiment building page.
:align: center
Expand All @@ -56,7 +56,7 @@ The AI will then run one or more experiments for which it chooses its own algori
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`.

.. image:: _static/ai_requested.png
.. image:: https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/ai_requested.png
:width: 400
:alt: Experiment building page.
:align: center
Expand All @@ -65,7 +65,7 @@ To configure the AI settings (for example, the number of experiments to run or t
Experiments
===========

.. image:: _static/experiments.png
.. image:: https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/experiments.png
:width: 600
:alt: Experiment building page.
:align: center
Expand All @@ -85,7 +85,7 @@ Clicking on any experiment will navigate to the **Results** page.
Results
=======

.. image:: _static/results.png
.. image:: https://media.githubusercontent.com/media/EpistasisLab/Aliro/master/docs/source/_static/results.png
:width: 600
:alt: The Results page.
:align: center
Expand Down

0 comments on commit 3d4040e

Please sign in to comment.