Adds API reference for poli

Author: miguelgondu

docs/protein-optimization/_autosummary/poli.core.abstract_black_box.AbstractBlackBox.rst

@@ -0,0 +1,25 @@
+poli.core.abstract\_black\_box.AbstractBlackBox
+===============================================
+
+.. currentmodule:: poli.core.abstract_black_box
+
+.. autoclass:: AbstractBlackBox
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~AbstractBlackBox.__init__
+      ~AbstractBlackBox.reset_evaluation_budget
+      ~AbstractBlackBox.set_observer
+      ~AbstractBlackBox.terminate
+   
+   
+
+   
+   
+   

docs/protein-optimization/_autosummary/poli.core.abstract_black_box.NegativeBlackBox.rst

@@ -0,0 +1,25 @@
+poli.core.abstract\_black\_box.NegativeBlackBox
+===============================================
+
+.. currentmodule:: poli.core.abstract_black_box
+
+.. autoclass:: NegativeBlackBox
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~NegativeBlackBox.__init__
+      ~NegativeBlackBox.reset_evaluation_budget
+      ~NegativeBlackBox.set_observer
+      ~NegativeBlackBox.terminate
+   
+   
+
+   
+   
+   

docs/protein-optimization/_autosummary/poli.core.abstract_black_box.rst

@@ -0,0 +1,30 @@
+poli.core.abstract\_black\_box
+==============================
+
+.. automodule:: poli.core.abstract_black_box
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      AbstractBlackBox
+      NegativeBlackBox
+   
+   
+
+   
+   
+   
+
+
+

docs/protein-optimization/_autosummary/poli.core.abstract_problem_factory.AbstractProblemFactory.rst

@@ -0,0 +1,24 @@
+poli.core.abstract\_problem\_factory.AbstractProblemFactory
+===========================================================
+
+.. currentmodule:: poli.core.abstract_problem_factory
+
+.. autoclass:: AbstractProblemFactory
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~AbstractProblemFactory.__init__
+      ~AbstractProblemFactory.create
+      ~AbstractProblemFactory.get_setup_information
+   
+   
+
+   
+   
+   

docs/protein-optimization/_autosummary/poli.core.abstract_problem_factory.MetaProblemFactory.rst

@@ -0,0 +1,23 @@
+poli.core.abstract\_problem\_factory.MetaProblemFactory
+=======================================================
+
+.. currentmodule:: poli.core.abstract_problem_factory
+
+.. autoclass:: MetaProblemFactory
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~MetaProblemFactory.__init__
+      ~MetaProblemFactory.mro
+   
+   
+
+   
+   
+   

docs/protein-optimization/_autosummary/poli.core.abstract_problem_factory.rst

@@ -0,0 +1,30 @@
+poli.core.abstract\_problem\_factory
+====================================
+
+.. automodule:: poli.core.abstract_problem_factory
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      AbstractProblemFactory
+      MetaProblemFactory
+   
+   
+
+   
+   
+   
+
+
+

docs/protein-optimization/_autosummary/poli.core.chemistry.rst

@@ -0,0 +1,31 @@
+poli.core.chemistry
+===================
+
+.. automodule:: poli.core.chemistry
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   poli.core.chemistry.tdc_black_box
+

docs/protein-optimization/_autosummary/poli.core.chemistry.tdc_black_box.TDCBlackBox.rst

@@ -0,0 +1,25 @@
+poli.core.chemistry.tdc\_black\_box.TDCBlackBox
+===============================================
+
+.. currentmodule:: poli.core.chemistry.tdc_black_box
+
+.. autoclass:: TDCBlackBox
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~TDCBlackBox.__init__
+      ~TDCBlackBox.reset_evaluation_budget
+      ~TDCBlackBox.set_observer
+      ~TDCBlackBox.terminate
+   
+   
+
+   
+   
+   

docs/protein-optimization/_autosummary/poli.core.chemistry.tdc_black_box.rst

@@ -0,0 +1,29 @@
+poli.core.chemistry.tdc\_black\_box
+===================================
+
+.. automodule:: poli.core.chemistry.tdc_black_box
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      TDCBlackBox
+   
+   
+
+   
+   
+   
+
+
+

docs/protein-optimization/_autosummary/poli.core.exceptions.BudgetExhaustedException.rst

@@ -0,0 +1,6 @@
+poli.core.exceptions.BudgetExhaustedException
+=============================================
+
+.. currentmodule:: poli.core.exceptions
+
+.. autoexception:: BudgetExhaustedException