Skip to content

Commit

Permalink
readme improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
HDembinski committed May 9, 2023
1 parent 9d4e30f commit 22221e1
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.rst
Expand Up @@ -28,7 +28,7 @@

*iminuit* is a Jupyter-friendly Python interface for the *Minuit2* C++ library maintained by CERN's ROOT team.

Minuit was designed to minimise statistical cost functions, for likelihood and least-squares fits of parametric models to data. It provides the best-fit parameters and error estimates from likelihood profile analysis.
Minuit was designed to minimize statistical cost functions, for likelihood and least-squares fits of parametric models to data. It provides the best-fit parameters and error estimates from likelihood profile analysis.

The iminuit package comes with additional features:

Expand All @@ -40,7 +40,7 @@ The iminuit package comes with additional features:
- Gaussian penalty terms for parameters
- Cost functions can be combined by adding them: ``total_cost = cost_1 + cost_2``
- Visualization of the fit in Jupyter notebooks
- Support for SciPy minimisers as alternatives to Minuit's Migrad algorithm (optional)
- Support for SciPy minimizers as alternatives to Minuit's MIGRAD algorithm (optional)
- Support for Numba accelerated functions (optional)

Dependencies
Expand Down Expand Up @@ -173,7 +173,7 @@ In a nutshell
Interactive fitting
-------------------

iminuit optionally supports an interactive fitting mode in Jupyter notebooks.
``iminuit`` optionally supports an interactive fitting mode in Jupyter notebooks.

.. image:: doc/_static/interactive_demo.gif
:alt: Animated demo of an interactive fit in a Jupyter notebook
Expand All @@ -185,11 +185,13 @@ When ``iminuit`` is used with cost functions and pdfs that are JIT-compiled with

.. image:: doc/_static/roofit_vs_iminuit+numba.svg

More information about this benchmark is given `in the Benchmark section of the documentation <https://iminuit.readthedocs.io/en/stable/benchmark.html#cost-function-benchmark>`_.

Partner projects
----------------

* `boost-histogram`_ from Scikit-HEP provides fast generalized histograms that you can use with the builtin cost functions.
* `numba_stats`_ provides faster implementations of probability density functions than scipy, and a few specific ones used in particle physics that are not in scipy.
* `boost-histogram`_ from Scikit-HEP provides fast generalized histograms that you can use with the builtin cost functions.
* `jacobi`_ provides a robust, fast, and accurate calculation of the Jacobi matrix of any transformation function and building a function for generic error propagation.

Versions
Expand Down

0 comments on commit 22221e1

Please sign in to comment.