v1.0.1

sbi-benchmark · Jan 11, 2021 · 26d60e6 · 26d60e6
1 parent fece89b
commit 26d60e6
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+# v1.0.1
+
+- Implemented `sbibm.get_results` for convenient fetching of benchmarking results
+
+
 # v1.0.0
 
 - Initial release
diff --git a/sbibm/__version__.py b/sbibm/__version__.py
@@ -1,3 +1,3 @@
-VERSION = (1, 0, 0)
+VERSION = (1, 0, 1)
 
 __version__ = ".".join(map(str, VERSION))
diff --git a/sbibm/utils/io.py b/sbibm/utils/io.py
@@ -17,11 +17,20 @@ def get_float_from_csv(
         return np.loadtxt(fh).astype(dtype)
 
 
-def get_results(dataset: str = "main_paper.csv"):
-    """Get results
+def get_results(
+    dataset: str = "main_paper.csv", subfolder: str = "benchmarking_sbi/results/"
+) -> pd.DataFrame:
+    """Get results from https://github.com/sbi-benchmark/results/
+
+    Args:
+        dataset: Filename for dataset
+        subfolder: Subfolder in repo
+
+    Returns:
+        Dataframe
     """
     df = pd.read_csv(
-        f"https://raw.githubusercontent.com/sbi-benchmark/benchmarking_sbi/main/results/{dataset}.csv"
+        f"https://raw.githubusercontent.com/sbi-benchmark/results/main/{subfolder}{dataset}"
     )
     return df