update config for svd to make it obvious that reference files should …

…be npy
flatironinstitute · Jul 17, 2024 · 531d3e6 · 531d3e6
1 parent 4804865
commit 531d3e6
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/config_files/config_svd.yaml b/config_files/config_svd.yaml
@@ -5,7 +5,7 @@ experiment_mode: "all_vs_ref" # options are "all_vs_all", "all_vs_ref"
 
 # optional unless experiment_mode is "all_vs_ref"
 reference_options:
-  path_to_reference: /path/to/reference
+  path_to_reference: /path/to/reference/gt_maps.npy
   n_volumes: 338 # optional, default is all volumes
   random_subset: False # if False, the subset is chosen as volumes[::skip_vols, ...] to satisfy n_volumes
 

diff --git a/tutorials/2_tutorial_svd.ipynb b/tutorials/2_tutorial_svd.ipynb
@@ -101,7 +101,7 @@
     "* experiment_mode (str): the options are \"all_vs_all\", \"all_vs_ref\". If you are using ref, then SVD is computed from the refence volumes and the rest of the volumes are projected to it. Otherwise, all volumes are used to do the projection\n",
     "\n",
     "* reference_options (dict)\n",
-    "    * path_to_reference (str): path to the reference volumes (only needed if mode is \"all_vs_ref\")\n",
+    "    * path_to_reference (str): path to the reference volumes (only needed if mode is \"all_vs_ref\"). Should be a .npy file that contains all the reference volumes, e.g., maps_flat.npy.\n",
     "    * n_volumes (int): number of volumes to use for analysis\n",
     "    * random_subset (bool): whether to use a random subset or not\n",
     "\n",