Merge remote-tracking branch 'origin/doc-redesign' into serialization…

…_2020

AUTHORS.rst

@@ -1,18 +1,17 @@
-Development Lead
-----------------
-
-* zfit <zfit@physik.uzh.ch>
-
-
+=======
 Authors
-------------
+=======
 
 | Jonas Eschle <Jonas.Eschle@cern.ch>
 | Albert Puig <apuignav@gmail.com>
 | Rafael Silva Coutinho <rsilvaco@cern.ch>
+| Nicola Serra <nserra@cern.ch>
 | Matthieu Marinangeli <matthieu.marinangeli@cern.ch>
 
+Development Lead
+----------------
 
+* zfit <zfit@physik.uzh.ch>
 
 Contributors
 ------------

CHANGELOG.rst

@@ -8,16 +8,56 @@ Develop
 
 Major Features and Improvements
 -------------------------------
-- add correlation method to FitResult
 
 Breaking changes
 ------------------
-- change name of `Gauss`, `Uniform` and `TruncatedGauss` to remove the `'_tfp'` at the end of the name
+- Minuit uses its own, internal gradient by default. To change this back, use `use_minuit_grad=False`
+- `minimize(params=...)` now filters correctly non-floating parameters.
+- `z.log` has been moved to `z.math.log` (following TF)
 
-Deprecations
+Depreceations
 -------------
 
 
+Bug fixes and small changes
+---------------------------
+- ncalls is not correctly using the internal heuristc or the ncalls explicitly
+- `minimize(params=...)` automatically extracts independent parameters.
+- fix copy issue of KDEV1 and change name to 'adaptive' (instead of 'adaptiveV1')
+- change exp name of `lambda_` to lam (in init)
+- add `set_yield` to BasePDF to allow setting the yield in place
+
+Experimental
+------------
+
+Requirement changes
+-------------------
+- upgrade to iminuit>=1.4
+- remove cloudpickle hack fix
+
+Thanks
+------
+
+
+0.5.3 (02.07.20)
+================
+
+Kernel density estimation for 1 dimension.
+
+Major Features and Improvements
+-------------------------------
+- add correlation method to FitResult
+- Gaussian (Truncated) Kernel Density Estimation in one dimension `zfit.pdf.GaussianKDE1DimV1` implementation with fixed and
+  adaptive bandwidth added as V1. This
+  is a feature that needs to be improved and feedback is welcome
+- Non-relativistic Breit-Wigner PDF, called Cauchy, implementation added.
+
+Breaking changes
+------------------
+- change human-readable name of `Gauss`, `Uniform` and `TruncatedGauss` to remove the `'_tfp'` at the end of the name
+
+
+
 Bug fixes and small changes
 ---------------------------
 - fix color wrong in printout of results, params
@@ -28,15 +68,12 @@ Bug fixes and small changes
   which is 2-3 times faster than previous algorithm.
 - add `from_minuit` constructor to `FitResult` allowing to create it when
   using directly iminuit
-
-Experimental
-------------
+- fix possible bias with sampling using accept-reject
 
 Requirement changes
 -------------------
+- pin down cloudpickle version (upstream bug with pip install) and TF, TFP versions
 
-Thanks
-------
 
 0.5.2 (13.05.2020)
 ==================

CONTRIBUTING.rst

@@ -1,15 +1,15 @@
 .. highlight:: shell
 
-============
-Contributing
-============
+=================
+How to contribute
+=================
 
 Contributions are welcome, and they are greatly appreciated! Every little bit
 helps, and credit will always be given.
 
 * You can report bugs at https://github.com/zfit/zfit/issues.
 * You can send feedback by filing an issue at https://github.com/zfit/zfit/issues or,
-for more informal discussions, you can also join our `Gitter channel <https://gitter.im/zfit/zfit>`_.
+  for more informal discussions, you can also join our `Gitter channel <https://gitter.im/zfit/zfit>`_.
 
 
 Get Started!

README.rst

@@ -1,3 +1,5 @@
+|zfit_logo|
+
 *******************************
 zfit: scalable pythonic fitting
 *******************************
@@ -15,6 +17,9 @@ zfit: scalable pythonic fitting
 .. image:: https://travis-ci.org/zfit/zfit.svg?branch=develop
    :target: https://travis-ci.org/zfit/zfit
 
+.. image:: https://github.com/zfit/zfit/workflows/Python%20package/badge.svg
+   :target: https://github.com/zfit/zfit/actions
+
 .. image:: https://coveralls.io/repos/github/zfit/zfit/badge.svg?branch=meta_changes
    :target: https://coveralls.io/github/zfit/zfit?branch=meta_changes
 
@@ -23,10 +28,7 @@ zfit: scalable pythonic fitting
    :alt: CodeFactor
 
 
-|zfit_logo|
-
-
-.. |zfit_logo| image:: docs/images/zfit-fin_400x168.png
+.. |zfit_logo| image:: docs/images/zfit-fin-hires.png
    :target: https://github.com/zfit/zfit
    :alt: zfit logo
 
@@ -37,7 +39,7 @@ zfit: scalable pythonic fitting
 zfit is a highly scalable and customizable model manipulation and fitting library. It uses
 `TensorFlow <https://www.tensorflow.org/>`_ as its computational backend
 and is optimised for simple and direct manipulation of probability density functions. The project is affiliated with
-and well integrated into `scikit-hep <https://scikit-hep.org/>`_, the HEP Python ecosystem.
+and well integrated into `Scikit-HEP <https://scikit-hep.org/>`_, the HEP Python ecosystem.
 
 - **Tutorials**: `Interactive IPython Tutorials <https://github.com/zfit/zfit-tutorials>`_
 - **Quick start**: `Example scripts <examples>`_
@@ -260,7 +262,7 @@ zfit has been developed with support from the University of Zürich and the Swis
 The idea of zfit is inspired by the `TensorFlowAnalysis <https://gitlab.cern.ch/poluekt/TensorFlowAnalysis>`_ framework developed by Anton Poluektov using the TensorFlow open source library.
 
 .. _documentation: https://zfit.readthedocs.io/en/latest/
-..  _stable documentation: https://zfit.readthedocs.io/en/0.5.2/
+..  _stable documentation: https://zfit.readthedocs.io/en/0.5.3/
 .. _API: https://zfit.readthedocs.io/en/latest/API.html
 
 

docs/.gitignore

@@ -1,2 +1,3 @@
 _build/
-/api/*.rst
+/full_api/*.rst
+!/full_api/index.rst

docs/_static/css/custom.css

@@ -0,0 +1,23 @@
+/* This line is theme specific - it includes the base theme CSS */
+@import 'index.css';
+
+#navbar-main {
+    background-color: #2C3E50!important;
+}
+
+.navbar-brand>.logo {
+    filter: drop-shadow(1px 1px 0px #ffffff88);
+}
+
+.nav-link {
+    color: #ffffff88!important;
+}
+
+.navbar-nav>.active>.nav-link {
+    font-weight: 600;
+    color: #CB5628!important;
+}
+
+i.fa-github-square:before {
+    color: #ffffff88;
+}

docs/_templates/autosummary/class.rst

@@ -0,0 +1,5 @@
+{{ objname | escape | underline(line='-') }}
+
+.. autoclass:: {{ fullname }}
+    :members:
+

docs/_templates/autosummary/function.rst

@@ -0,0 +1,4 @@
+{{ name | escape | underline(line='-') }}
+
+.. autofunction:: {{ fullname }}
+