Skip to content

Commit 38d6133

Browse files
committed
Fixed bug with dl.freedist
`dl.freedist` added to the documentaion but hidden from the other models in API references.
1 parent b1fa552 commit 38d6133

3 files changed

Lines changed: 15 additions & 0 deletions

File tree

deerlab/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ def __getattr__(name):
1111
return _bg_models_mod.__getattr__(name)
1212
raise AttributeError(f"module 'deerlab' has no attribute {name!r}")
1313

14+
from .dd_models import freedist
1415
from .model import Model, Penalty, Parameter, link, lincombine, merge, relate
1516
from .deerload import deerload
1617
from .selregparam import selregparam

deerlab/dd_models.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,19 @@ def _multirice3dfun(r,nu,sig):
135135
# =================================================================
136136

137137
def freedist(r):
138+
"""General Non-parametric distribution model, seldom needed by the user.
139+
Used when creating a model that is a linear combination of two parameter-free models
140+
141+
Parameters
142+
----------
143+
r : array_like
144+
Distance axis, in nanometers.
145+
146+
Returns
147+
-------
148+
Model
149+
150+
"""
138151
def _nonparametric():
139152
return np.eye(len(r))
140153
# Create model

docsrc/source/reference.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,3 +85,4 @@ Reference Index
8585
der_snr
8686
formatted_table
8787
show_config
88+
freedist

0 commit comments

Comments
 (0)