docs: Add docstring for public method

scikit-hep · Oct 10, 2023 · d9ccf67 · d9ccf67
1 parent 0bf30b8
commit d9ccf67
Show file tree

Hide file tree

Showing 2 changed files with 77 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -226,6 +226,17 @@ Utilities
    digest
    citation
 
+Experimental
+------------
+
+.. currentmodule:: pyhf.experimental
+
+.. autosummary::
+   :toctree: _generated/
+   :nosignatures:
+
+   modifiers
+
 Contrib
 -------
 

diff --git a/src/pyhf/experimental/modifiers.py b/src/pyhf/experimental/modifiers.py
@@ -173,6 +173,72 @@ def apply(self, pars):
 def add_custom_modifier(
     func_name: str, deps: list[str], new_params: dict[str, dict[str, Sequence[float]]]
 ) -> dict[str, tuple[BaseBuilder, BaseApplier]]:
+    r"""
+    Add a custom modifier type with the modifier data defined through a custom
+    numexpr string expression.
+
+    Example:
+
+        >>> import pyhf
+        >>> import pyhf.experimental.modifiers
+        >>> pyhf.set_backend("numpy")
+        >>> new_params = {
+        ...     "m1": {"inits": (1.0,), "bounds": ((-5.0, 5.0),)},
+        ...     "m2": {"inits": (1.0,), "bounds": ((-5.0, 5.0),)},
+        ... }
+        >>> expanded_pyhf = pyhf.experimental.modifiers.add_custom_modifier(
+        ...     "custom", ["m1", "m2"], new_params
+        ... )
+        >>> model = pyhf.Model(
+        ...     {
+        ...         "channels": [
+        ...             {
+        ...                 "name": "singlechannel",
+        ...                 "samples": [
+        ...                     {
+        ...                         "name": "signal",
+        ...                         "data": [10, 20],
+        ...                         "modifiers": [
+        ...                             {
+        ...                                 "name": "f2",
+        ...                                 "type": "custom",
+        ...                                 "data": {"expr": "m1"},
+        ...                             },
+        ...                         ],
+        ...                     },
+        ...                     {
+        ...                         "name": "background",
+        ...                         "data": [100, 150],
+        ...                         "modifiers": [
+        ...                             {
+        ...                                 "name": "f1",
+        ...                                 "type": "custom",
+        ...                                 "data": {"expr": "m1+(m2**2)"},
+        ...                             },
+        ...                         ],
+        ...                     },
+        ...                 ],
+        ...             }
+        ...         ]
+        ...     },
+        ...     modifier_set=expanded_pyhf,
+        ...     poi_name="m1",
+        ...     validate=False,
+        ...     batch_size=1,
+        ... )
+        >>> model.config.modifiers
+        [('f1', 'custom'), ('f2', 'custom')]
+
+    Args:
+        func_name (:obj:`str`): The name of the custom modifier type.
+        deps (:obj:`list`): The names of the new parameters of the modifier
+         function.
+        new_params (:obj:`dict`): The new parameters.
+
+    Returns:
+        :obj:`dict`: The updated ``pyhf.modifiers.histfactory_set`` with the added
+        custom modifier type.
+    """
     _builder = make_builder(func_name, deps, new_params)
     _applier = make_applier(func_name, deps, new_params)