Skip to content

Commit

Permalink
fixed links and added sudo hints
Browse files Browse the repository at this point in the history
  • Loading branch information
musslick committed Oct 23, 2024
1 parent baf3997 commit 04291c6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/examples/closed-loop-bandit-task/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ First, we need to set up our local AutoRA project.
## Create Repository
To ease the setup process for this example, we provide a template repository that contains all the necessary files and configurations.

Simply visit the following repository on GitHub: https://github.com/AutoResearch/autora-closed-loop-firebase-prolific-bandit-task
Simply visit the following repository on GitHub: [https://github.com/AutoResearch/autora-closed-loop-firebase-prolific-bandit-task](https://github.com/AutoResearch/autora-closed-loop-firebase-prolific-bandit-task)

Next, click on the green "Use this template" button to create a new repository in your account.
![use_template.png](../img/use_template.png)
Expand Down Expand Up @@ -75,6 +75,9 @@ npm install -g firebase-tools

We will use this package to deploy our firebase functions for storing data.

!!! hint
If you encounter any issues with the installation, make sure that you have the necessary permissions to install packages on your system. You may need to run the commands with `sudo` or as an administrator.

## Set Up Project Folder with Coockiecutter

To establish an online closed-loop for AutoRA, there are two key components that need to be configured:
Expand Down Expand Up @@ -120,6 +123,9 @@ You should now have the following project structure:

![project_structure.png](../img/project_structure.png)

!!! hint
If you encounter any issues with the cookiecutter setup, make sure that you have the necessary permissions to install packages on your system. You may need to run the commands with `sudo` or as an administrator.

[Next: Set up Firebase to host our experiment.](firebase.md)


6 changes: 6 additions & 0 deletions docs/examples/closed-loop-basic/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@ npm install -g firebase-tools

We will use this package to deploy our firebase functions for storing data.

!!! hint
If you encounter any issues with the installation, make sure that you have the necessary permissions to install packages on your system. You may need to run the commands with `sudo` or as an administrator.

## Set Up Project Folder with Coockiecutter

To establish an online closed-loop for AutoRA, there are two key components that need to be configured:
Expand Down Expand Up @@ -122,6 +125,9 @@ python -m cookiecutter https://github.com/AutoResearch/autora-user-cookiecutter

![project_structure.png](../img/project_structure.png)

!!! hint
If you encounter any issues with the cookiecutter setup, make sure that you have the necessary permissions to install packages on your system. You may need to run the commands with `sudo` or as an administrator.

## Next Steps

[Next: Set up Firebase to host our experiment.](firebase.md)
Expand Down

0 comments on commit 04291c6

Please sign in to comment.