Merge pull request #7 from cvnlab/jacob-port

minor ports to python: example01 description and changing wantshrinkage default to True
cvnlab · Apr 28, 2024 · ecb1cfd · ecb1cfd
2 parents e8d5bd1 + 9e13a7b
commit ecb1cfd
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 35 deletions.
diff --git a/.gitignore b/.gitignore
@@ -77,6 +77,9 @@ target/
 # Jupyter Notebook
 .ipynb_checkpoints
 
+# Matlab data files
+*.mat
+
 # IPython
 profile_default/
 ipython_config.py

diff --git a/examples/example1.ipynb b/examples/example1.ipynb
diff --git a/gsn/perform_gsn.py b/gsn/perform_gsn.py
@@ -10,7 +10,7 @@ def perform_gsn(data, opt=None):
 
     opt (dict, optional): A dictionary with the following optional fields:
         wantverbose (bool, optional): Whether to print status statements. Default is True.
-        wantshrinkage (bool, optional): Whether to use shrinkage in the estimation of covariance. Default is False.
+        wantshrinkage (bool, optional): Whether to use shrinkage in the estimation of covariance. Default is True.
 
     Returns:
     results: A dictionary with the results containing:
@@ -47,7 +47,7 @@ def perform_gsn(data, opt=None):
     if 'wantverbose' not in opt or opt['wantverbose'] is None:
         opt['wantverbose'] = 1
     if 'wantshrinkage' not in opt or opt['wantshrinkage'] is None:
-        opt['wantshrinkage'] = 0
+        opt['wantshrinkage'] = 1
 
     # Prepare opt for rsa_noise_ceiling.py
     opt['mode'] = 1