deploy: fc08f7f

BioinfoMachineLearning · Aug 12, 2024 · 2046969 · 2046969
commit 2046969
Show file tree

Hide file tree

Showing 154 changed files with 26,798 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: f23c6ab9669e54224c4ae5d11bda1307
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/acknowledgements.doctree b/.doctrees/acknowledgements.doctree
diff --git a/.doctrees/available_methods.doctree b/.doctrees/available_methods.doctree
diff --git a/.doctrees/bonus.doctree b/.doctrees/bonus.doctree
diff --git a/.doctrees/citing_this_work.doctree b/.doctrees/citing_this_work.doctree
diff --git a/.doctrees/codeautolink-cache.json b/.doctrees/codeautolink-cache.json
@@ -0,0 +1,26 @@
+{
+  "acknowledgements": [],
+  "available_methods": [],
+  "bonus": [],
+  "citing_this_work": [],
+  "comparative_plots": [],
+  "configs/analysis": [],
+  "configs/data": [],
+  "configs/model": [],
+  "data_preparation": [],
+  "ensemble_inference": [],
+  "for_developers": [],
+  "index": [],
+  "installation": [],
+  "method_inference": [],
+  "modules/posebench.binding_site_crop_preparation": [],
+  "modules/posebench.complex_alignment": [],
+  "modules/posebench.data_utils": [],
+  "modules/posebench.ensemble_generation": [],
+  "modules/posebench.inference_relaxation": [],
+  "modules/posebench.minimize_energy": [],
+  "modules/posebench.model_utils": [],
+  "modules/posebench.resolvers": [],
+  "modules/posebench.utils": [],
+  "tutorials": []
+}
diff --git a/.doctrees/comparative_plots.doctree b/.doctrees/comparative_plots.doctree
diff --git a/.doctrees/configs/analysis.doctree b/.doctrees/configs/analysis.doctree
diff --git a/.doctrees/configs/data.doctree b/.doctrees/configs/data.doctree
diff --git a/.doctrees/configs/model.doctree b/.doctrees/configs/model.doctree
diff --git a/.doctrees/data_preparation.doctree b/.doctrees/data_preparation.doctree
diff --git a/.doctrees/ensemble_inference.doctree b/.doctrees/ensemble_inference.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/for_developers.doctree b/.doctrees/for_developers.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/installation.doctree b/.doctrees/installation.doctree
diff --git a/.doctrees/method_inference.doctree b/.doctrees/method_inference.doctree
diff --git a/.doctrees/modules/posebench.binding_site_crop_preparation.doctree b/.doctrees/modules/posebench.binding_site_crop_preparation.doctree
diff --git a/.doctrees/modules/posebench.complex_alignment.doctree b/.doctrees/modules/posebench.complex_alignment.doctree
diff --git a/.doctrees/modules/posebench.data_utils.doctree b/.doctrees/modules/posebench.data_utils.doctree
diff --git a/.doctrees/modules/posebench.ensemble_generation.doctree b/.doctrees/modules/posebench.ensemble_generation.doctree
diff --git a/.doctrees/modules/posebench.inference_relaxation.doctree b/.doctrees/modules/posebench.inference_relaxation.doctree
diff --git a/.doctrees/modules/posebench.minimize_energy.doctree b/.doctrees/modules/posebench.minimize_energy.doctree
diff --git a/.doctrees/modules/posebench.model_utils.doctree b/.doctrees/modules/posebench.model_utils.doctree
diff --git a/.doctrees/modules/posebench.resolvers.doctree b/.doctrees/modules/posebench.resolvers.doctree
diff --git a/.doctrees/modules/posebench.utils.doctree b/.doctrees/modules/posebench.utils.doctree
diff --git a/.doctrees/tutorials.doctree b/.doctrees/tutorials.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/PoseBench.png b/_images/PoseBench.png
diff --git a/_images/WorkBench.jpeg b/_images/WorkBench.jpeg
diff --git a/_images/social_previews/summary_acknowledgements_11a2cab9.png b/_images/social_previews/summary_acknowledgements_11a2cab9.png
diff --git a/_images/social_previews/summary_available_methods_7c48ede4.png b/_images/social_previews/summary_available_methods_7c48ede4.png
diff --git a/_images/social_previews/summary_bonus_555ffd58.png b/_images/social_previews/summary_bonus_555ffd58.png
diff --git a/_images/social_previews/summary_citing_this_work_3bf7880d.png b/_images/social_previews/summary_citing_this_work_3bf7880d.png
diff --git a/_images/social_previews/summary_comparative_plots_9fa326ec.png b/_images/social_previews/summary_comparative_plots_9fa326ec.png
diff --git a/_images/social_previews/summary_configs_analysis_02d94955.png b/_images/social_previews/summary_configs_analysis_02d94955.png
diff --git a/_images/social_previews/summary_configs_data_939b3d32.png b/_images/social_previews/summary_configs_data_939b3d32.png
diff --git a/_images/social_previews/summary_configs_model_214477e1.png b/_images/social_previews/summary_configs_model_214477e1.png
diff --git a/_images/social_previews/summary_data_preparation_e59b2fee.png b/_images/social_previews/summary_data_preparation_e59b2fee.png
diff --git a/_images/social_previews/summary_ensemble_inference_a10c727d.png b/_images/social_previews/summary_ensemble_inference_a10c727d.png
diff --git a/_images/social_previews/summary_for_developers_5db0cab2.png b/_images/social_previews/summary_for_developers_5db0cab2.png
diff --git a/_images/social_previews/summary_index_28286b9c.png b/_images/social_previews/summary_index_28286b9c.png
diff --git a/_images/social_previews/summary_installation_8d2b686f.png b/_images/social_previews/summary_installation_8d2b686f.png
diff --git a/_images/social_previews/summary_method_inference_34164cb9.png b/_images/social_previews/summary_method_inference_34164cb9.png
diff --git a/...l_previews/summary_modules_posebench.binding_site_crop_preparation_9668f5aa.png b/...l_previews/summary_modules_posebench.binding_site_crop_preparation_9668f5aa.png
diff --git a/_images/social_previews/summary_modules_posebench.complex_alignment_1ef687e6.png b/_images/social_previews/summary_modules_posebench.complex_alignment_1ef687e6.png
diff --git a/_images/social_previews/summary_modules_posebench.data_utils_26925c64.png b/_images/social_previews/summary_modules_posebench.data_utils_26925c64.png
diff --git a/_images/social_previews/summary_modules_posebench.ensemble_generation_39ac3963.png b/_images/social_previews/summary_modules_posebench.ensemble_generation_39ac3963.png
diff --git a/...ges/social_previews/summary_modules_posebench.inference_relaxation_f3165fc8.png b/...ges/social_previews/summary_modules_posebench.inference_relaxation_f3165fc8.png
diff --git a/_images/social_previews/summary_modules_posebench.minimize_energy_5f5c42a6.png b/_images/social_previews/summary_modules_posebench.minimize_energy_5f5c42a6.png
diff --git a/_images/social_previews/summary_modules_posebench.model_utils_9ea4468d.png b/_images/social_previews/summary_modules_posebench.model_utils_9ea4468d.png
diff --git a/_images/social_previews/summary_modules_posebench.resolvers_a917f3b3.png b/_images/social_previews/summary_modules_posebench.resolvers_a917f3b3.png
diff --git a/_images/social_previews/summary_modules_posebench.utils_c6c740e4.png b/_images/social_previews/summary_modules_posebench.utils_c6c740e4.png
diff --git a/_images/social_previews/summary_tutorials_d58fb0b6.png b/_images/social_previews/summary_tutorials_d58fb0b6.png
diff --git a/_modules/index.html b/_modules/index.html
diff --git a/_modules/posebench/__init__.html b/_modules/posebench/__init__.html
diff --git a/_modules/posebench/analysis/complex_alignment.html b/_modules/posebench/analysis/complex_alignment.html
diff --git a/_modules/posebench/data/binding_site_crop_preparation.html b/_modules/posebench/data/binding_site_crop_preparation.html
diff --git a/_modules/posebench/models/ensemble_generation.html b/_modules/posebench/models/ensemble_generation.html
diff --git a/_modules/posebench/models/inference_relaxation.html b/_modules/posebench/models/inference_relaxation.html
diff --git a/_modules/posebench/models/minimize_energy.html b/_modules/posebench/models/minimize_energy.html
diff --git a/_modules/posebench/utils/data_utils.html b/_modules/posebench/utils/data_utils.html
diff --git a/_modules/posebench/utils/model_utils.html b/_modules/posebench/utils/model_utils.html
diff --git a/_modules/posebench/utils/utils.html b/_modules/posebench/utils/utils.html
diff --git a/_sources/acknowledgements.rst.txt b/_sources/acknowledgements.rst.txt
@@ -0,0 +1,6 @@
+Acknowledgements
+================
+
+.. mdinclude:: ../../README.md
+    :start-line: 875
+    :end-line: 892
diff --git a/_sources/available_methods.rst.txt b/_sources/available_methods.rst.txt
@@ -0,0 +1,9 @@
+Available inference methods
+================
+
+.. mdinclude:: ../../README.md
+    :start-line: 286
+    :end-line: 323
+
+.. 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/_sources/bonus.rst.txt b/_sources/bonus.rst.txt
@@ -0,0 +1,11 @@
+Bonus
+================
+
+.. mdinclude:: ../../README.md
+    :start-line: 910
+    :end-line: 912
+
+.. image:: ./_static/WorkBench.jpeg
+  :alt: My brain after building PoseBench
+  :align: center
+  :width: 400
diff --git a/_sources/citing_this_work.rst.txt b/_sources/citing_this_work.rst.txt
@@ -0,0 +1,6 @@
+Citing this work
+================
+
+.. mdinclude:: ../../README.md
+    :start-line: 894
+    :end-line: 906
diff --git a/_sources/comparative_plots.rst.txt b/_sources/comparative_plots.rst.txt
@@ -0,0 +1,6 @@
+How to create comparative plots of inference results
+================
+
+.. mdinclude:: ../../README.md
+    :start-line: 822
+    :end-line: 831
diff --git a/_sources/configs/analysis.rst.txt b/_sources/configs/analysis.rst.txt
@@ -0,0 +1,33 @@
+Analysis
+==============
+
+This section describes the configurations for various analysis-related scripts.
+
+Complex alignment
+--------------------------
+
+This config file is used to determine how a predicted protein-ligand complex structure is optimally aligned to a corresponding ground-truth protein-ligand complex.
+
+.. literalinclude:: ../../../configs/analysis/complex_alignment.yaml
+    :language: yaml
+    :caption: :file:`analysis/complex_alignment.yaml`
+
+
+Inference analysis (PoseBusters, Astex, and DockGen)
+--------------------------
+
+This config file is used to determine how to score a predicted protein-ligand complex from the PoseBusters Benchmark, Astex Diverse, or DockGen datasets.
+
+.. literalinclude:: ../../../configs/analysis/inference_analysis.yaml
+    :language: yaml
+    :caption: :file:`analysis/inference_analysis.yaml`
+
+
+Inference analysis (CASP)
+--------------------------
+
+This config file is used to determine how to score a predicted protein-ligand complex from the CASP15 dataset.
+
+.. literalinclude:: ../../../configs/analysis/inference_analysis_casp.yaml
+    :language: yaml
+    :caption: :file:`analysis/inference_analysis_casp.yaml`
diff --git a/_sources/configs/data.rst.txt b/_sources/configs/data.rst.txt
@@ -0,0 +1,82 @@
+Data
+==============
+
+This section describes the configurations for various data-related scripts.
+
+
+Input data components
+------------------------
+
+These data component configurations are used to modify how the input (apo) protein structures are predicted or aligned.
+
+Protein apo-to-holo alignment
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/data/components/protein_apo_to_holo_alignment.yaml
+    :language: yaml
+    :caption: :file:`data/components/protein_apo_to_holo_alignment.yaml`
+
+Protein FASTA preparation
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/data/components/protein_fasta_preparation.yaml
+    :language: yaml
+    :caption: :file:`data/components/protein_fasta_preparation.yaml`
+
+ESMFold sequence preparation
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/data/components/esmfold_sequence_preparation.yaml
+    :language: yaml
+    :caption: :file:`data/components/esmfold_sequence_preparation.yaml`
+
+
+Method data parsers
+------------------------
+
+These data parser configurations are used to modify how the input (output) protein-ligand complex structures of each method are prepared (extracted).
+
+Binding site crop preparation
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/data/binding_site_crop_preparation.yaml
+    :language: yaml
+    :caption: :file:`data/binding_site_crop_preparation.yaml`
+
+DiffDock input preparation
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/data/diffdock_input_preparation.yaml
+    :language: yaml
+    :caption: :file:`data/diffdock_input_preparation.yaml`
+
+FABind input preparation
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/data/fabind_input_preparation.yaml
+    :language: yaml
+    :caption: :file:`data/fabind_input_preparation.yaml`
+
+DynamicBind input preparation
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/data/dynamicbind_input_preparation.yaml
+    :language: yaml
+    :caption: :file:`data/dynamicbind_input_preparation.yaml`
+
+NeuralPLexer input preparation
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/data/neuralplexer_input_preparation.yaml
+    :language: yaml
+    :caption: :file:`data/neuralplexer_input_preparation.yaml`
+
+RoseTTAFold-All-Atom input preparation
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/data/rfaa_input_preparation.yaml
+    :language: yaml
+    :caption: :file:`data/rfaa_input_preparation.yaml`
+
+RoseTTAFold-All-Atom output extraction
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/data/rfaa_output_extraction.yaml
+    :language: yaml
+    :caption: :file:`data/rfaa_output_extraction.yaml`
+
+TULIP output extraction
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/data/tulip_output_extraction.yaml
+    :language: yaml
+    :caption: :file:`data/tulip_output_extraction.yaml`
diff --git a/_sources/configs/model.rst.txt b/_sources/configs/model.rst.txt
@@ -0,0 +1,83 @@
+Model
+==============
+
+This section describes the configurations for various method-related scripts.
+
+
+Method inference
+------------------------
+
+These configurations are used to specify how inference is performed with each method.
+
+DiffDock inference
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/model/diffdock_inference.yaml
+    :language: yaml
+    :caption: :file:`model/diffdock_inference.yaml`
+
+FABind inference
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/model/fabind_inference.yaml
+    :language: yaml
+    :caption: :file:`model/fabind_inference.yaml`
+
+DynamicBind inference
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/model/dynamicbind_inference.yaml
+    :language: yaml
+    :caption: :file:`model/dynamicbind_inference.yaml`
+
+NeuralPLexer inference
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/model/neuralplexer_inference.yaml
+    :language: yaml
+    :caption: :file:`model/neuralplexer_inference.yaml`
+
+RoseTTAFold-All-Atom inference
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/model/rfaa_inference.yaml
+    :language: yaml
+    :caption: :file:`model/rfaa_inference.yaml`
+
+Vina inference
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/model/vina_inference.yaml
+    :language: yaml
+    :caption: :file:`model/vina_inference.yaml`
+
+
+Ensemble inference
+------------------------
+
+This configuration is used to specify how inference is performed with a method ensemble (e.g., via `consensus` ranking).
+
+.. note::
+    This script not only enables inference with a method ensemble, but it also provides a unified wrapper with which one
+    can relax and structure a method's predictions in a CASP-compliant file format for scoring.
+
+Ensemble generation
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/model/ensemble_generation.yaml
+    :language: yaml
+    :caption: :file:`model/ensemble_generation.yaml`
+
+
+Structure relaxation
+------------------------
+
+These configurations are used to specify how relaxation is (optionally) applied to a predicted protein-ligand complex structure using molecular dynamics (i.e., `OpenMM <https://openmm.org>`_).
+
+.. note::
+    The `inference_relaxation` configuration describes the behavior of the script that serves as an entry point for the relaxation process. The `minimize_energy` configuration is a multi-ligand generalization of the main energy minimization script originally implemented for the `PoseBusters <https://github.com/maabuu/posebusters_em>`_ software suite.
+
+Inference relaxation (entry point)
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/model/inference_relaxation.yaml
+    :language: yaml
+    :caption: :file:`model/inference_relaxation.yaml`
+
+Minimize energy (relaxation engine)
+^^^^^^^^^^^^^^^^^^^^^^^^
+.. literalinclude:: ../../../configs/model/minimize_energy.yaml
+    :language: yaml
+    :caption: :file:`model/minimize_energy.yaml`
diff --git a/_sources/data_preparation.rst.txt b/_sources/data_preparation.rst.txt
@@ -0,0 +1,6 @@
+How to prepare `PoseBench` data
+================
+
+.. mdinclude:: ../../README.md
+    :start-line: 147
+    :end-line: 280
diff --git a/_sources/ensemble_inference.rst.txt b/_sources/ensemble_inference.rst.txt
@@ -0,0 +1,9 @@
+How to run inference with a method ensemble
+================
+
+.. mdinclude:: ../../README.md
+    :start-line: 763
+    :end-line: 814
+
+.. 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/_sources/for_developers.rst.txt b/_sources/for_developers.rst.txt
@@ -0,0 +1,6 @@
+For developers
+================
+
+.. mdinclude:: ../../README.md
+    :start-line: 837
+    :end-line: 871
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,71 @@
+.. PoseBench documentation master file, created by
+   sphinx-quickstart on Sun May 12 14:49:07 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to PoseBench's documentation!
+============================================
+
+
+.. mdinclude:: ../../README.md
+    :start-line: 4
+    :end-line: 13
+
+.. image:: ./_static/PoseBench.png
+  :alt: Overview of PoseBench
+  :align: center
+  :width: 600
+
+.. mdinclude:: ../../README.md
+    :start-line: 19
+    :end-line: 21
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   installation
+   tutorials
+   data_preparation
+   available_methods
+   method_inference
+   ensemble_inference
+   comparative_plots
+   for_developers
+   acknowledgements
+   citing_this_work
+   bonus
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+   :hidden:
+   :caption: Default Configs
+
+   configs/analysis
+   configs/data
+   configs/model
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+   :hidden:
+   :caption: API Reference
+
+   modules/posebench.binding_site_crop_preparation
+   modules/posebench.complex_alignment
+   modules/posebench.inference_relaxation
+   modules/posebench.minimize_energy
+   modules/posebench.ensemble_generation
+   modules/posebench.data_utils
+   modules/posebench.model_utils
+   modules/posebench.utils
+   modules/posebench.resolvers
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/_sources/installation.rst.txt b/_sources/installation.rst.txt
@@ -0,0 +1,6 @@
+Installation
+================
+
+.. mdinclude:: ../../README.md
+    :start-line: 41
+    :end-line: 129
diff --git a/_sources/method_inference.rst.txt b/_sources/method_inference.rst.txt
@@ -0,0 +1,6 @@
+How to run inference with individual methods
+================
+
+.. mdinclude:: ../../README.md
+    :start-line: 331
+    :end-line: 757
diff --git a/_sources/modules/posebench.binding_site_crop_preparation.rst.txt b/_sources/modules/posebench.binding_site_crop_preparation.rst.txt
@@ -0,0 +1,4 @@
+Binding site crop preparation
+==============
+.. automodule:: posebench.data.binding_site_crop_preparation
+   :members:
diff --git a/_sources/modules/posebench.complex_alignment.rst.txt b/_sources/modules/posebench.complex_alignment.rst.txt
@@ -0,0 +1,4 @@
+Complex alignment
+==============
+.. automodule:: posebench.analysis.complex_alignment
+   :members: