Skip to content

Commit d48dc31

Browse files
committed
fix ups
1 parent ce7e555 commit d48dc31

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

doc/api.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,15 @@ An object for defining fit modes.
111111

112112
Mode
113113

114+
Associated objects allow for defining mode parameters.
115+
116+
.. currentmodule:: specparam.modes.params
117+
118+
.. autosummary::
119+
:toctree: generated/
120+
121+
ParamDefinition
122+
114123
Metrics
115124
~~~~~~~
116125

examples/customize/plot_custom_metrics.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ def compute_total_error(power_spectrum, modeled_spectrum):
7575
# information the :class:`~specparam.metrics.metric` object is used to define a metric.
7676
#
7777
# The Metric object requires the following information:
78+
#
7879
# - `category`: a description of what kind of metric it is
7980
# - `measure`: a label for the specific measure that is defined
8081
# - `description`: a description of the custom metric

examples/customize/plot_custom_modes.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
# sphinx_gallery_thumbnail_number = 3
99

10+
# Import functionality used to define custom fit modes
11+
from collections import OrderedDict
1012
import numpy as np
1113

1214
# Import the model object
@@ -15,9 +17,6 @@
1517
# Import function to simulate a power spectrum
1618
from specparam.sim import sim_power_spectrum
1719

18-
# Import OrderedDict, used in mode definition
19-
from collections import OrderedDict
20-
2120
# Import objects used to define a custom mode
2221
from specparam.modes.mode import Mode
2322
from specparam.modes.params import ParamDefinition

0 commit comments

Comments
 (0)