Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jammy2211 committed Jul 23, 2024
1 parent b3ad3eb commit 526f4c8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/overview/scientific_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ For simpler scenarios, adjustments might include:
In more intricate cases, models might involve numerous parameters and complex compositions of multiple model components.

**PyAutoFit** offers a sophisticated model composition API designed to handle these complexities. It provides
tools for constructing elaborate models using lists of Python classes and hierarchical structures of Python classes.
tools for constructing elaborate models using lists of Python classes, NumPy arrays and hierarchical structures of Python classes.

For a detailed exploration of these capabilities, you can refer to
the `model cookbook <https://pyautofit.readthedocs.io/en/latest/cookbooks/model.html>`_, which provides comprehensive
Expand Down
10 changes: 5 additions & 5 deletions docs/overview/the_basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -298,13 +298,13 @@ Analysis

We now tell **PyAutoFit** how to fit the model to the data.

We define an `Analysis` class, which includes:
We define an ``Analysis`` class, which includes:

- An `__init__` constructor that takes `data` and `noise_map` as inputs (this can be extended with additional elements necessary for fitting the model to the data).
- An ``__init__`` constructor that takes ``data`` and ``noise_map`` as inputs (this can be extended with additional elements necessary for fitting the model to the data).

- A `log_likelihood_function` that defines how to fit an `instance` of the model to the data and return a log likelihood value.
- A ``log_likelihood_function`` that defines how to fit an ``instance`` of the model to the data and return a log likelihood value.

Read the comments and docstrings of the `Analysis` class in detail for a full description of how the analysis works.
Read the comments and docstrings of the ``Analysis`` class in detail for a full description of how the analysis works.

.. code-block:: python
Expand Down Expand Up @@ -623,7 +623,7 @@ examples demonstrating more complex model-fitting tasks.

This includes cookbooks, which provide a concise reference guide to the **PyAutoFit** API for advanced model-fitting:

- [Model Cookbook](https://pyautofit.readthedocs.io/en/latest/cookbooks/model.html): Learn how to compose complex models using multiple Python classes, lists, dictionaries, and customize their parameterization.
- [Model Cookbook](https://pyautofit.readthedocs.io/en/latest/cookbooks/model.html): Learn how to compose complex models using multiple Python classes, lists, dictionaries, NumPy arrays and customize their parameterization.

- [Analysis Cookbook](https://pyautofit.readthedocs.io/en/latest/cookbooks/search.html): Customize the analysis with model-specific output and visualization to gain deeper insights into your model fits.

Expand Down

0 comments on commit 526f4c8

Please sign in to comment.