feat: Update required_parset to pass in sample data and modifier data (#774)

* Modify required_parset API to allow sample data and modifier data to be passed through

Author: kratsg

src/pyhf/cli/spec.py

@@ -43,7 +43,7 @@ def inspect(workspace, output_file, measurement):
         (
             parname,
             modifiers.registry[result['modifiers'][parname]]
-            .required_parset(0)['paramset_type']
+            .required_parset([], [])['paramset_type']
             .__name__,
         )
         for parname in ws.parameters

src/pyhf/modifiers/__init__.py

@@ -90,38 +90,38 @@ def modifier(*args, **kwargs):
     #   >>> @modifiers.modifier
     #   >>> ... class myCustomModifier(object):
     #   >>> ...   @classmethod
-    #   >>> ...   def required_parset(cls, npars): pass
+    #   >>> ...   def required_parset(cls, sample_data, modifier_data): pass
     #
     #   >>> @modifiers.modifier(name='myCustomNamer')
     #   >>> ... class myCustomModifier(object):
     #   >>> ...   @classmethod
-    #   >>> ...   def required_parset(cls, npars): pass
+    #   >>> ...   def required_parset(cls, sample_data, modifier_data): pass
     #
     #   >>> @modifiers.modifier(constrained=False)
     #   >>> ... class myUnconstrainedModifier(object):
     #   >>> ...   @classmethod
-    #   >>> ...   def required_parset(cls, npars): pass
+    #   >>> ...   def required_parset(cls, sample_data, modifier_data): pass
     #   >>> ...
     #   >>> myUnconstrainedModifier.pdf_type
     #   None
     #
     #   >>> @modifiers.modifier(constrained=True, pdf_type='poisson')
     #   >>> ... class myConstrainedCustomPoissonModifier(object):
     #   >>> ...   @classmethod
-    #   >>> ...   def required_parset(cls, npars): pass
+    #   >>> ...   def required_parset(cls, sample_data, modifier_data): pass
     #   >>> ...
     #   >>> myConstrainedCustomGaussianModifier.pdf_type
     #   'poisson'
     #
     #   >>> @modifiers.modifier(constrained=True)
     #   >>> ... class myCustomModifier(object):
     #   >>> ...   @classmethod
-    #   >>> ...   def required_parset(cls, npars): pass
+    #   >>> ...   def required_parset(cls, sample_data, modifier_data): pass
     #
     #   >>> @modifiers.modifier(op_code='multiplication')
     #   >>> ... class myMultiplierModifier(object):
     #   >>> ...   @classmethod
-    #   >>> ...   def required_parset(cls, npars): pass
+    #   >>> ...   def required_parset(cls, sample_data, modifier_data): pass
     #   >>> ...
     #   >>> myMultiplierModifier.op_code
     #   'multiplication'

src/pyhf/modifiers/histosys.py

@@ -11,7 +11,7 @@
 @modifier(name='histosys', constrained=True, op_code='addition')
 class histosys(object):
     @classmethod
-    def required_parset(cls, n_parameters):
+    def required_parset(cls, sample_data, modifier_data):
         return {
             'paramset_type': constrained_by_normal,
             'n_parameters': 1,

src/pyhf/modifiers/lumi.py

@@ -10,7 +10,7 @@
 @modifier(name='lumi', constrained=True, pdf_type='normal', op_code='multiplication')
 class lumi(object):
     @classmethod
-    def required_parset(cls, n_parameters):
+    def required_parset(cls, sample_data, modifier_data):
         return {
             'paramset_type': constrained_by_normal,
             'n_parameters': 1,

src/pyhf/modifiers/normfactor.py

@@ -10,7 +10,7 @@
 @modifier(name='normfactor', op_code='multiplication')
 class normfactor(object):
     @classmethod
-    def required_parset(cls, n_parameters):
+    def required_parset(cls, sample_data, modifier_data):
         return {
             'paramset_type': unconstrained,
             'n_parameters': 1,

src/pyhf/modifiers/normsys.py

@@ -11,7 +11,7 @@
 @modifier(name='normsys', constrained=True, op_code='multiplication')
 class normsys(object):
     @classmethod
-    def required_parset(cls, n_parameters):
+    def required_parset(cls, sample_data, modifier_data):
         return {
             'paramset_type': constrained_by_normal,
             'n_parameters': 1,

src/pyhf/modifiers/shapefactor.py

@@ -10,15 +10,15 @@
 @modifier(name='shapefactor', op_code='multiplication')
 class shapefactor(object):
     @classmethod
-    def required_parset(cls, n_parameters):
+    def required_parset(cls, sample_data, modifier_data):
         return {
             'paramset_type': unconstrained,
-            'n_parameters': n_parameters,
+            'n_parameters': len(sample_data),
             'modifier': cls.__name__,
             'is_constrained': cls.is_constrained,
             'is_shared': True,
-            'inits': (1.0,) * n_parameters,
-            'bounds': ((0.0, 10.0),) * n_parameters,
+            'inits': (1.0,) * len(sample_data),
+            'bounds': ((0.0, 10.0),) * len(sample_data),
         }
 
 

src/pyhf/modifiers/shapesys.py

@@ -12,19 +12,19 @@
 )
 class shapesys(object):
     @classmethod
-    def required_parset(cls, n_parameters):
+    def required_parset(cls, sample_data, modifier_data):
         return {
             'paramset_type': constrained_by_poisson,
-            'n_parameters': n_parameters,
+            'n_parameters': len(sample_data),
             'modifier': cls.__name__,
             'is_constrained': cls.is_constrained,
             'is_shared': False,
-            'inits': (1.0,) * n_parameters,
-            'bounds': ((1e-10, 10.0),) * n_parameters,
+            'inits': (1.0,) * len(sample_data),
+            'bounds': ((1e-10, 10.0),) * len(sample_data),
             # nb: auxdata/factors set by finalize. Set to non-numeric to crash
             # if we fail to set auxdata/factors correctly
-            'auxdata': (None,) * n_parameters,
-            'factors': (None,) * n_parameters,
+            'auxdata': (None,) * len(sample_data),
+            'factors': (None,) * len(sample_data),
         }
 
 

src/pyhf/modifiers/staterror.py

@@ -10,16 +10,16 @@
 @modifier(name='staterror', constrained=True, op_code='multiplication')
 class staterror(object):
     @classmethod
-    def required_parset(cls, n_parameters):
+    def required_parset(cls, sample_data, modifier_data):
         return {
             'paramset_type': constrained_by_normal,
-            'n_parameters': n_parameters,
+            'n_parameters': len(sample_data),
             'modifier': cls.__name__,
             'is_constrained': cls.is_constrained,
             'is_shared': True,
-            'inits': (1.0,) * n_parameters,
-            'bounds': ((1e-10, 10.0),) * n_parameters,
-            'auxdata': (1.0,) * n_parameters,
+            'inits': (1.0,) * len(sample_data),
+            'bounds': ((1e-10, 10.0),) * len(sample_data),
+            'auxdata': (1.0,) * len(sample_data),
         }
 
 

src/pyhf/pdf.py

@@ -39,7 +39,7 @@ def _paramset_requirements_from_channelspec(spec, channel_nbins):
                 try:
                     paramset_requirements = modifiers.registry[
                         modifier_def['type']
-                    ].required_parset(len(sample['data']))
+                    ].required_parset(sample['data'], modifier_def['data'])
                 except KeyError:
                     log.exception(
                         'Modifier not implemented yet (processing {0:s}). Available modifiers: {1}'.format(