Result-Review-O3b-lensing.md

+# Aim
+This repository deals with the result review of the machine learning based pipeline, [**lensid**](https://git.ligo.org/srashti.goyal/lensid), for the LVK O3b lensing analysis, to identify the potential strongly lensed candidate BBH event pairs.
+
+## Useful links
+- Code review page:[here](https://git.ligo.org/srashti.goyal/lensid/-/wikis/Code-Review/)
+- Code review statement: [here] (https://git.ligo.org/srashti.goyal/lensid/-/wikis/Code-review-statement-for-lensid)
+- O3 analysis repository: [here](https://git.ligo.org/srashti.goyal/lensid-ml-o3/-/tree/master/)
+- O3 lensid results summary: [here](https://git.ligo.org/srashti.goyal/lensid-ml-o3/-/wikis/O3-result-updates)
+- Methods paper: [here](https://arxiv.org/abs/2106.12466)
+- Methods presentation: [slides](https://docs.google.com/presentation/d/10bIhtFae5RIJ3WBJg1Lcy7PueSKwxh1m2APRDN0w0PA/edit?usp=sharing)
+
+# Final statement
+
+# Result review
+
+## Scripts/Configs
+
+| Script | Short description | Status | git hash | Comment | final sign-off |
+|--------|-------------------|--------|----------|---------|----------------|
+| [ml_predict_workflow.py](https://git.ligo.org/srashti.goyal/lensid/-/blob/master/package/lensid/ml_predict_workflow.py), [config_O3_events.yaml](https://git.ligo.org/srashti.goyal/lensid-ml-o3/-/blob/master/config_O3_events.yaml) | Script for computing ML predictions for a given event pairs in dataframe, their skymaps, Qtransforms and the trained ML models. Optionally computes the False Positive Probabilities given the background. It requires config file as input. Eg: `lensid_make_predictions -config /home/srashti.goyal/lensid-ml-O3/config_O3_events.yaml` Note: change `odir` in **config** file. | -------- | ---------- | DC: Should be considered in the results review | ---------------- |
+| [config_train_test_workflow.yaml](https://git.ligo.org/srashti.goyal/lensid/-/blob/master/train_test_workflow/config_train_test_workflow.yaml) | config file for training and testing ML models. Note: change `base_out_dir` as desired. | OK-DC; question-jrc |  |  |  |
+| [train_three_densenets.py]
+| [get_candidates_compare_to_blu_tagged.ipynb](https://git.ligo.org/srashti.goyal/lensid-ml-o3/-/blob/master/O3_ML_gwtc3/get_candidates_compare_to_blu_tagged.ipynb) | Notebook for comparing ML and BLU results for the full O3 catalogue of BBHs. | -------- | ---------- | --------- | ---------------- |
+| [condor_lensid_make_predictions.py](https://git.ligo.org/srashti.goyal/lensid-ml-o3/-/blob/master/condor_lensid_make_predictions.py), [config_O3_events.yaml](https://git.ligo.org/srashti.goyal/lensid-ml-o3/-/blob/master/config_O3_events.yaml) | Condor Script for computing ML predictions and FPPs using, [ml_predict_workflow.py](https://git.ligo.org/srashti.goyal/lensid/-/blob/master/package/lensid/ml_predict_workflow.py). Eg: `python condor_lensid_make_predictions` Note: change `exec_file_loc` in the script according to your installation and `odir` in config file. | OK-DC | ca47c5ce71fa7405b84c944235a8646abcd216d4 | --------- | ---------------- |
+
+
+## Investigations
+| Notebook | Short description | Status | git hash | Comment | final sign-off |
+|----------|-------------------|--------|----------|---------|----------------|
+| [train_test_pars.ipynb](https://git.ligo.org/srashti.goyal/lensid/-/blob/master/review/train_test_pars.ipynb) | Notebook having plots of injection parameters for training, testing and O3a sets that are used. | ------ | -------- | ------- | -------------- |
+| [ML_blu_FPPs_inj_pars_investigate.ipynb](https://git.ligo.org/srashti.goyal/lensid/-/blob/master/review/ML_blu_FPPs_inj_pars_investigate.ipynb) | Notebook comparing the ML and BLU FPPs for each pair in test set, and also investigationg correlations with the injection parameters. Also contain statistics of input sky features for lensed and unlensed test pairs. | ------ | -------- | ------- | -------------- |
+| [PSD_plots.ipynb](https://git.ligo.org/srashti.goyal/lensid/-/blob/master/review/PSD_plots.ipynb) | Notebook having plots of PSDs that are used. | ------ | -------- | ------- | -------------- |
+| [background_injections_ML_blu.ipynb](https://git.ligo.org/srashti.goyal/lensid/-/blob/master/notebooks/O3a_events/background_injections_ML_blu.ipynb) | Notebook showing ML and BLU outputs for the background unlensed injections as simulated by Haris during O3a analysis. | ------ | -------- | ------- | -------------- |
+| [investigations_visualisations.ipynb](https://git.ligo.org/srashti.goyal/lensid-ml-o3/-/blob/master/review/investigations_visualisations.ipynb) | Notebook to visualise qtransforms and skymaps of the interesting candidate real event pairs. | -------- | Should this be reviewed? | --------- | ---------------- |
+| [comparison_with_golum.ipynb](https://git.ligo.org/srashti.goyal/lensid-ml-o3/-/blob/master/review/comparison_with_golum.ipynb) | Notebook to compare the Golum's results with lensid and posterior overlap FPPs for the candidate pairs in O3 | -------- | ------- | --------- | ---------------- |
+| [optimise_densenets.py](https://git.ligo.org/srashti.goyal/lensid/-/blob/master/development/optimise_densenets.py) [notebook] | Optimise densenet learning rates, with and without whitening of strain | -------- | ------- | --------- | ---------------- |
+|[optimise_XGB_QTs.ipynb](https://git.ligo.org/srashti.goyal/lensid/-/blob/master/development/optimise_XGB_QTs.ipynb) | Optimise XGBoost algotithm for ML with qtransforms hyperparameters | -------- | ------- | --------- | ---------------- |
+
+## Results
+
+In progress: [page](https://git.ligo.org/srashti.goyal/lensid-ml-o3/-/wikis/O3-result-updates)
+## O3b paper
+|[notebook](https://git.ligo.org/srashti.goyal/lensid-ml-o3/-/blob/master/O3_ML_gwtc3/plot_ml_blu_predictions.ipynb)| Plot for selecting the pairs for Joint-PE analysis.| -------- | ------- | --------- | ---------------- |
+