Skip to content

Commit bea8f14

Browse files
committed
update: adjust line references in documentation includes for consistency, and update PoseBench image
1 parent 09092b4 commit bea8f14

15 files changed

Lines changed: 28 additions & 24 deletions

docs/source/_static/PoseBench.png

-1.14 MB
Loading

docs/source/acknowledgements.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ Acknowledgements
22
================
33

44
.. mdinclude:: ../../README.md
5-
:start-line: 1309
6-
:end-line: 1332
5+
:start-line: 1311
6+
:end-line: 1334

docs/source/available_methods.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ Available inference methods
22
================
33

44
.. mdinclude:: ../../README.md
5-
:start-line: 367
6-
:end-line: 412
5+
:start-line: 369
6+
:end-line: 414
77

88
.. note::
99
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!

docs/source/bonus.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ Bonus
22
================
33

44
.. mdinclude:: ../../README.md
5-
:start-line: 1350
6-
:end-line: 1352
5+
:start-line: 1352
6+
:end-line: 1354
77

88
.. image:: ./_static/WorkBench.jpeg
99
:alt: My brain after building PoseBench

docs/source/citing_this_work.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ Citing this work
22
================
33

44
.. mdinclude:: ../../README.md
5-
:start-line: 1334
6-
:end-line: 1346
5+
:start-line: 1336
6+
:end-line: 1348

docs/source/comparative_plots.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ How to create comparative plots of inference results
22
================
33

44
.. mdinclude:: ../../README.md
5-
:start-line: 1237
6-
:end-line: 1265
5+
:start-line: 1239
6+
:end-line: 1267

docs/source/data_preparation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ How to prepare `PoseBench` data
22
================
33

44
.. mdinclude:: ../../README.md
5-
:start-line: 207
6-
:end-line: 359
5+
:start-line: 209
6+
:end-line: 361
77

88
.. note::
99
The preprocessed Astex Diverse, PoseBusters Benchmark, DockGen, and CASP15 data (available via Zenodo at https://doi.org/10.5281/zenodo.19138652) provide pre-holo-aligned protein structures predicted by AlphaFold 3 (and alternatively MIT-licensed ESMFold) for these respective datasets. Accordingly, users must ensure their usage of such predicted protein structures from AlphaFold 3 aligns with AlphaFold 3's Terms of Use at https://github.com/google-deepmind/alphafold3/blob/main/WEIGHTS_TERMS_OF_USE.md.

docs/source/ensemble_inference.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ How to run inference with a method ensemble
22
================
33

44
.. mdinclude:: ../../README.md
5-
:start-line: 1178
6-
:end-line: 1229
5+
:start-line: 1180
6+
:end-line: 1231
77

88
.. note::
99
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).

docs/source/for_developers.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ For developers
22
================
33

44
.. mdinclude:: ../../README.md
5-
:start-line: 1271
6-
:end-line: 1305
5+
:start-line: 1273
6+
:end-line: 1307

docs/source/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ Welcome to PoseBench's documentation!
2020
:start-line: 20
2121
:end-line: 22
2222

23+
.. mdinclude:: ../../README.md
24+
:start-line: 24
25+
:end-line: 26
26+
2327

2428
.. toctree::
2529
:maxdepth: 2

0 commit comments

Comments
 (0)