Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jammy2211 committed Apr 29, 2024
1 parent d3fa966 commit 1b9dc65
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion autofit/non_linear/search/nest/dynesty/search/static.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ def __init__(self, function):
def grad(self):
import jax
from jax import grad

print("Compiling gradient")
return jax.jit(grad(self.function))

Expand Down Expand Up @@ -135,6 +134,7 @@ def search_internal_from(
The number of CPU's over which multiprocessing is performed, determining how many samples are stored
in the dynesty queue for samples.
"""

if self.use_gradient:
gradient = GradWrapper(fitness)
else:
Expand Down
12 changes: 7 additions & 5 deletions docs/cookbooks/result.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,13 @@ The output appears as follows:
Loading From Hard-disk
----------------------

When performing fits which output results to hard-disc, a ``files`` folder is created containing .json / .csv files of
the model, samples, search, etc.
When performing fits which output results to hard-disk, a `files` folder is created containing .json / .csv files of
the model, samples, search, etc. You should check it out now for a completed fit on your hard-disk if you have
not already!

These files can be loaded from hard-disk to Python variables via the aggregator, making them accessible in a
Python script or Jupyter notebook.
These files can be loaded from hard-disk to Python variables via the aggregator, making them accessible in a
Python script or Jupyter notebook. They are loaded as the internal **PyAutoFit** objects we are familiar with,
for example the `model` is loaded as the `Model` object we passed to the search above.

Below, we will access these results using the aggregator's ``values`` method. A full list of what can be loaded is
as follows:
Expand All @@ -126,7 +128,7 @@ the full non-linear search samples, for example every parameter sample and its l
contains a summary of the results, for example the maximum log likelihood model and error estimates on parameters
at 1 and 3 sigma confidence.

Accessing results via the ``samples_summary`` is much faster, because as it does reperform calculations using the full
Accessing results via the ``samples_summary`` is much faster, because as it does not reperform calculations using the full
list of samples. Therefore, if the result you want is accessible via the ``samples_summary`` you should use it
but if not you can revert to the ``samples.
Expand Down
1 change: 0 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ typing-inspect>=0.4.0
emcee>=3.1.3
gprof2dot==2021.2.21
matplotlib
networkx
numpydoc>=1.0.0
pyprojroot==0.2.0
pyswarms==1.3.0
Expand Down

0 comments on commit 1b9dc65

Please sign in to comment.