warns when provide params for profile method

wcxve · Jan 3, 2025 · 200f331 · 200f331
1 parent 3e1ea79
commit 200f331
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/src/elisa/infer/results.py b/src/elisa/infer/results.py
@@ -973,6 +973,9 @@ def _(p):
             fn_dic = {d: factory(d) for d in mapping.values()}
 
         if method == 'profile':
+            if params is not None:
+                warnings.warn('params is ignored when using profile method')
+
             # use log transform to stabilize the profile likelihood
             def transform(f):
                 def _(p):
@@ -1808,7 +1811,8 @@ def flux(
             Whether to use logarithmically regular energy grid. The default is
             True.
         params : dict, optional
-            Parameters dict to overwrite the fitted parameters.
+            Parameters dict to overwrite the fitted parameters. Ignored when
+            `method` is ``'profile'``.
 
         Returns
         -------
@@ -1876,7 +1880,8 @@ def lumin(
             Whether to use logarithmically regular energy grid. The default is
             True.
         params : dict, optional
-            Parameters dict to overwrite the fitted parameters.
+            Parameters dict to overwrite the fitted parameters. Ignored when
+            `method` is ``'profile'``.
         cosmo : LambdaCDM, optional
             Cosmology model used to calculate luminosity. The default is
             Planck18.
@@ -1960,7 +1965,8 @@ def eiso(
             Whether to use logarithmically regular energy grid. The default
             is True.
         params : dict, optional
-            Parameters dict to overwrite the fitted parameters.
+            Parameters dict to overwrite the fitted parameters. Ignored when
+            `method` is ``'profile'``.
         cosmo : LambdaCDM, optional
             Cosmology model used to calculate luminosity. The default is
             Planck18.