Skip to content

Commit

Permalink
Fix docstring for hssm.Link
Browse files Browse the repository at this point in the history
  • Loading branch information
digicosmos86 committed Nov 16, 2023
1 parent 9840c25 commit dc926d9
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions src/hssm/link.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,24 @@ class Link(bmb.Link):
Parameters
----------
name : str
name
The name of the link function. If it is a known name, it's not necessary to pass
any other arguments because functions are already defined internally. If not
known, all of `link``, ``linkinv`` and ``linkinv_backend`` must be specified.
link : function
link : optional
A function that maps the response to the linear predictor. Known as the
:math:`g` function in GLM jargon. Does not need to be specified when ``name``
is a known name.
linkinv : function
linkinv : optional
A function that maps the linear predictor to the response. Known as the
:math:`g^{-1}` function in GLM jargon. Does not need to be specified when
``name`` is a known name.
linkinv_backend : function
linkinv_backend : optional
Same than ``linkinv`` but must be something that works with PyMC backend
(i.e. it must work with PyTensor tensors). Does not need to be specified when
``name`` is a known name.
bounds : optional
Bounds of the response scale. Only needed when ``name`` is ``gen_logit``.
"""

def __init__(
Expand Down

0 comments on commit dc926d9

Please sign in to comment.