Skip to content

Commit a8bd2fb

Browse files
committed
update obj descriptions
1 parent 109aad0 commit a8bd2fb

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

specparam/models/model.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,13 @@ class SpectralModel(BaseModel):
3838
Which approach to take for fitting the aperiodic component.
3939
periodic_mode : {'gaussian', 'skewed_gaussian', 'cauchy'}
4040
Which approach to take for fitting the periodic component.
41+
metrics : Metrics or list of Metric or list or str
42+
Metrics definition(s) to use to evaluate the model.
43+
bands : Bands or dict or int or None, optional
44+
Bands object with band definitions, or definition that can be turned into a Bands object.
45+
debug : bool, optional, default: False
46+
Whether to run in debug mode.
47+
If in debug, any errors encountered during fitting will raise an error.
4148
verbose : bool, optional, default: True
4249
Verbosity mode. If True, prints out warnings and general status updates.
4350
**model_kwargs

specparam/objs/results.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ class Results():
3737
Modes object with fit mode definitions.
3838
metrics : Metrics
3939
Metrics object with metric definitions.
40-
bands : Bands
41-
Bands object with band definitions.
40+
bands : Bands or dict or int or None
41+
Bands object with band definitions, or definition that can be turned into a Bands object.
4242
4343
Attributes
4444
----------

0 commit comments

Comments
 (0)