updated examples section in docs

Author: Ameek94

README.md

@@ -63,8 +63,6 @@ BOBE has several optional dependencies for extended functionality. When installi
 
 ## Quick Start
 
-### Simple python function
-
 ```python
 from BOBE import BOBE
 

docs/build/doctrees/environment.pickle

@@ -115,7 +115,7 @@ <h1>Python Module Index</h1>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="BOBE.html#module-BOBE.acquisition"><code class="xref">BOBE.acquisition</code></a></td><td>
+       <a href="api/acquisition.html#module-BOBE.acquisition"><code class="xref">BOBE.acquisition</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
@@ -125,7 +125,7 @@ <h1>Python Module Index</h1>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="BOBE.html#module-BOBE.clf"><code class="xref">BOBE.clf</code></a></td><td>
+       <a href="api/gp_models.html#module-BOBE.clf"><code class="xref">BOBE.clf</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
@@ -145,7 +145,7 @@ <h1>Python Module Index</h1>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="api/core.html#module-BOBE.optim"><code class="xref">BOBE.optim</code></a></td><td>
+       <a href="api/optim.html#module-BOBE.optim"><code class="xref">BOBE.optim</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
@@ -172,11 +172,6 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="api/utils.html#module-BOBE.utils.plot"><code class="xref">BOBE.utils.plot</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-1">
-       <td></td>
-       <td>&#160;&#160;&#160;
-       <a href="api/utils.html#module-BOBE.utils.results"><code class="xref">BOBE.utils.results</code></a></td><td>
-       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;

docs/build/html/genindex.html

@@ -13,20 +13,3 @@ The main Bayesian Optimization for Bayesian Evidence class.
    :undoc-members:
    :show-inheritance:
 
-BOBEResults Class  
------------------
-
-Results container for BOBE optimization runs.
-
-.. autoclass:: BOBE.utils.results.BOBEResults
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Optimization Functions
-----------------------
-
-.. automodule:: BOBE.optim
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/build/html/objects.inv

@@ -1,14 +1,16 @@
 API Reference
 =============
 
-Complete API documentation for all BOBE modules.
+Complete API documentation for all BOBE modules (work in progress).
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    core
    acquisition
    gp_models
    likelihood
    samplers
+   optim
    utils
+

docs/build/html/py-modindex.html

@@ -0,0 +1,10 @@
+Optimization
+============
+
+Optimization Functions
+----------------------
+
+.. automodule:: BOBE.optim
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/searchindex.js

@@ -1,7 +1,7 @@
 Sampling the likelihood surrogate
 ==================================
 
-JaxBo provides interfaces for nested sampling via Dynesty and HMC using NUTS from NumPyro. 
+BOBE provides interfaces for nested sampling via Dynesty and HMC using NUTS from NumPyro. 
 These are used for sampling the Gaussian Process surrogate of the likelihood function to calculate the evidence or generate posterior samples.
 
 Nested Sampling