Created FARSI Documentation

docs/source/FARSI_sim.md

@@ -0,0 +1,78 @@
+# FARSI Simulator Documentation
+
+#### Make sure to do the following beforehand: 
+
+1. Clone the oss-arch-gym repository.
+2. Complete the set up of vizier.
+3. Activate the "arch-gym" conda environment
+
+## Installing FARSI simulator
+The below commands are to replace the existing Project_FARSI folder with its latest version as a submodule. The shell script also updates the conda environment dependencies required for FARSI, and installs ACME framework for reinforcement learning.
+
+(Note: the script takes a while to run): 
+```
+cd oss-arch-gym/
+rm -r Project_FARSI
+git rm -r --cached Project_FARSI
+./install_sim.sh
+```
+Type "farsi" as the answer (in the terminal) to ```"Which simulator (cfu,farsi) do you want to use (cfu, viz, farsi)?"```
+
+Replace the content of ```Project_FARSI/settings/config_cacti.py``` file with this:
+
+```
+import os
+
+# get the base path of arch-gym
+base_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '../..'))
+
+
+cact_bin_addr = os.path.join(base_path, "Project_FARSI/cacti_for_FARSI/cacti")
+
+print(cact_bin_addr, os.path.exists(cact_bin_addr))
+
+cacti_param_addr = os.path.join(base_path, "Project_FARSI/cacti_for_FARSI/farsi_gen.cfg")
+
+print(cacti_param_addr, os.path.exists(cacti_param_addr))
+
+cacti_data_log_file = os.path.join(base_path, "Project_FARSI/cacti_for_FARSI/data_log.csv")
+
+print(cacti_data_log_file, os.path.exists(cacti_data_log_file))
+
+```
+
+In ```Project_FARSI/settings/config.py```, replace the following line (line 276):
+```
+database_data_dir = os.path.join(home_dir, "specs", "database_data")
+```
+with this:
+```
+database_data_dir = os.path.join(home_dir, "oss-arch-gym", "Project_FARSI", "specs", "database_data")
+```
+
+
+## Running Training Scripts
+
+Inside ```sims/FARSI_sim```:
+
+* **Ant Colony Optimization**: ```python train_aco_FARSIEnv.py```
+
+* **Bayesian Optimization**: ```python train_bo_FARSIEnv.py.py```
+
+* **Genetic Algorithm**: ```python train_ga_FARSIEnv.py```
+
+* **Random Walker**: ```python train_randomwalker_FARSIEnv.py```
+
+* **Reinforcement Learning**: ```python train_single_agent.py```
+
+* **Emukit Algorithm**: ```python train_emukit_vizier.py```
+
+* **Grid-Search Algorithm**: ```python train_gridsearch_vizier.py```
+
+* **Quasi-Random Algorithm**: ```python train_quasirandom_vizier.py```
+
+* **Random-Search Algorithm**: ```python train_randomsearch_vizier.py```
+
+
+## Updating Hyperparameters
+You can update hyperparameters of the different algorithms in their respective .py files shown above.