Update README and docs

BioinfoMachineLearning · Aug 13, 2024 · 7be0aa0 · 7be0aa0
1 parent 56202cf
commit 7be0aa0
Show file tree

Hide file tree

Showing 14 changed files with 85 additions and 66 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/source/acknowledgements.rst b/docs/source/acknowledgements.rst
@@ -2,5 +2,5 @@ Acknowledgements
 ================
 
 .. mdinclude:: ../../README.md
-    :start-line: 875
-    :end-line: 892
+    :start-line: 887
+    :end-line: 904
diff --git a/docs/source/available_methods.rst b/docs/source/available_methods.rst
@@ -2,8 +2,8 @@ Available inference methods
 ================
 
 .. mdinclude:: ../../README.md
-    :start-line: 286
-    :end-line: 323
+    :start-line: 287
+    :end-line: 324
 
 .. note::
     Have a new method to add? Please let us know by creating a pull request. We would be happy to work with you to integrate new methodology into this benchmark!
diff --git a/docs/source/bonus.rst b/docs/source/bonus.rst
@@ -2,8 +2,8 @@ Bonus
 ================
 
 .. mdinclude:: ../../README.md
-    :start-line: 910
-    :end-line: 912
+    :start-line: 922
+    :end-line: 924
 
 .. image:: ./_static/WorkBench.jpeg
   :alt: My brain after building PoseBench

diff --git a/docs/source/citing_this_work.rst b/docs/source/citing_this_work.rst
@@ -2,5 +2,5 @@ Citing this work
 ================
 
 .. mdinclude:: ../../README.md
-    :start-line: 894
-    :end-line: 906
+    :start-line: 906
+    :end-line: 918
diff --git a/docs/source/comparative_plots.rst b/docs/source/comparative_plots.rst
@@ -2,5 +2,5 @@ How to create comparative plots of inference results
 ================
 
 .. mdinclude:: ../../README.md
-    :start-line: 822
-    :end-line: 831
+    :start-line: 834
+    :end-line: 843
diff --git a/docs/source/data_preparation.rst b/docs/source/data_preparation.rst
@@ -2,5 +2,5 @@ How to prepare `PoseBench` data
 ================
 
 .. mdinclude:: ../../README.md
-    :start-line: 147
-    :end-line: 280
+    :start-line: 148
+    :end-line: 281
diff --git a/docs/source/ensemble_inference.rst b/docs/source/ensemble_inference.rst
@@ -2,8 +2,8 @@ How to run inference with a method ensemble
 ================
 
 .. mdinclude:: ../../README.md
-    :start-line: 763
-    :end-line: 814
+    :start-line: 775
+    :end-line: 828
 
 .. note::
     In addition to having `consensus` as an available value for `ensemble_ranking_method`, one can also set `ensemble_ranking_method=ff` to have the method ensemble's top-ranked predictions selected using the criterion of "minimum (molecular dynamics) force field energy" (albeit while incurring a very large runtime complexity).
diff --git a/docs/source/for_developers.rst b/docs/source/for_developers.rst
@@ -2,5 +2,5 @@ For developers
 ================
 
 .. mdinclude:: ../../README.md
-    :start-line: 837
-    :end-line: 871
+    :start-line: 849
+    :end-line: 883
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -29,6 +29,7 @@ Welcome to PoseBench's documentation!
    tutorials
    data_preparation
    available_methods
+   sweep_inference
    method_inference
    ensemble_inference
    comparative_plots

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -2,5 +2,5 @@ Installation
 ================
 
 .. mdinclude:: ../../README.md
-    :start-line: 41
-    :end-line: 129
+    :start-line: 42
+    :end-line: 130
diff --git a/docs/source/method_inference.rst b/docs/source/method_inference.rst
@@ -2,5 +2,5 @@ How to run inference with individual methods
 ================
 
 .. mdinclude:: ../../README.md
-    :start-line: 331
-    :end-line: 757
+    :start-line: 352
+    :end-line: 769
diff --git a/docs/source/sweep_inference.rst b/docs/source/sweep_inference.rst
@@ -0,0 +1,6 @@
+How to run a sweep of benchmarking experiments
+================
+
+.. mdinclude:: ../../README.md
+    :start-line: 332
+    :end-line: 346
diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst
@@ -2,5 +2,5 @@ Tutorials
 ================
 
 .. mdinclude:: ../../README.md
-    :start-line: 135
-    :end-line: 141
+    :start-line: 136
+    :end-line: 142