Added readme to the vis dashboard.

Signed-off-by: TheRootOf3 <[email protected]>
Adamliu1 · Sep 14, 2024 · c8e9997 · c8e9997
1 parent d5cc1c6
commit c8e9997
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/results_viz/img.png b/results_viz/img.png
diff --git a/results_viz/readme.md b/results_viz/readme.md
@@ -0,0 +1,19 @@
+# Super-cool data analysis dashboard!
+
+Welcome to this wonderful super-cool dashboard. To visualise results of some experiment, make sure the results have been already aggregated into a single file by running the `aggregate_experiment_results.py` script on the experiment directory (directory right above the `experiment_data`). E.g.:
+
+```python3
+python3 llm_unlearn_ucl/aggregate_experiment_results.py --experiment_dir ./20240911_llama3-8b_results/results_3_seq_1e-6
+```
+
+This command generates a joint csv file containing all of the experimental results in `experiment_data/aggregated_df.csv`.
+
+To visualise the results, make sure you have `dash` and `pandas` installed and simply run the app with the path to the experiment directory. E.g.:
+
+```python3
+python3 app.py --experiment_path ./20240911_llama3-8b_results/results_3_seq_1e-6
+```
+
+## Woo-hoo! 🎉
+
+![](./img.png)