comment on what _mtype_result gives us

scikit-hep · Sep 20, 2018 · 1c76044 · 1c76044
1 parent 758a7da
commit 1c76044
Showing 1 changed file with 26 additions and 1 deletion.
diff --git a/pyhf/pdf.py b/pyhf/pdf.py
@@ -146,7 +146,32 @@ def _mtype_results(self,mtype,pars):
             if mtype in self.combined_mods.keys():
                 return self.combined_mods[mtype].apply(pars)
 
-        before the loops.
+        before the loops. This returns a bookkeeping dictionary of the following structure
+
+            _mtype_results_dict == {
+                channel1: {
+                    sample1: [
+                        mod1.apply(),
+                        mod2.apply(),
+                        ...
+                    ],
+                    sample2: [
+                        mod1.apply(),
+                        mod3.apply(),
+                        mod5.apply(),
+                        ...
+                    ]
+                },
+                channel2: {
+                    sample2: [
+                        mod2.apply(),
+                        mod3.apply(),
+                        mod4.apply()
+                    ],
+                    ...
+                },
+                ...
+            }
         """
         mtype_results = {}
         for channel in self.spec['channels']: