ADD: callgraph + clean-up

.gitignore

@@ -149,5 +149,8 @@ dmypy.json
 # Sequence and metadata
 **/experiments/data/**
 
-# personal scratchpad
+# Any callgraphs
+**.svg
+
+# My personal scratchpad
 x_*

README.md

@@ -25,6 +25,15 @@ To evaluate the best trial (trial < experiment) of all launched experiments, run
 python q2_ritme/eval_best_trial_overall.py --model_path "experiments/models"
 ````
 
+## Call graphs
+To create a call graph for all functions in the package, run the following commands:
+````
+pip install pyan3==1.1.1
+
+pyan3 q2_ritme/**/*.py --uses --no-defines --colored --grouped --annotated --svg --exclude 'q2_ritme/evaluate_all_experiments.py' --exclude 'q2_ritme/eval_best_trial_overall.py' --exclude 'q2_ritme._version' > call_graph.svg
+````
+(Note: different other options to create call graphs were tested such as code2flow and snakeviz. However, these although properly maintained didn't directly output call graphs such as pyan3 did.)
+
 ## Background
 ### Why ray tune?
 "By using tuning libraries such as Ray Tune we can try out combinations of hyperparameters. Using sophisticated search strategies, these parameters can be selected so that they are likely to lead to good results (avoiding an expensive exhaustive search). Also, trials that do not perform well can be preemptively stopped to reduce waste of computing resources. Lastly, Ray Tune also takes care of training these runs in parallel, greatly increasing search speed." [source](https://docs.ray.io/en/latest/tune/examples/tune-xgboost.html#tune-xgboost-ref)

q2_ritme/run_config.json

@@ -12,7 +12,7 @@
     "xgb",
     "nn"
   ],
-  "num_trials": 1,
+  "num_trials": 2,
   "path_to_ft": null,
   "path_to_md": null,
   "seed_data": 12,

q2_ritme/run_n_eval_tune.py

@@ -29,7 +29,7 @@ def parse_args():
     return parser.parse_args()
 
 
-def main(config_path):
+def run_n_eval_tune(config_path):
     with open(config_path, "r") as f:
         config = json.load(f)
 
@@ -116,4 +116,4 @@ def main(config_path):
 
 if __name__ == "__main__":
     args = parse_args()
-    main(args.config)
+    run_n_eval_tune(args.config)