Skip to content

Commit effda84

Browse files
Format find_MAP docstring
1 parent a54cb12 commit effda84

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

pymc3/tuning/starting.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,11 @@ def find_MAP(
4949
*args,
5050
**kwargs
5151
):
52-
"""
53-
Finds the local maximum a posteriori point given a model.
52+
"""Finds the local maximum a posteriori point given a model.
5453
55-
find_MAP should not be used to initialize the NUTS sampler. Simply call pymc3.sample() and it will automatically initialize NUTS in a better way.
54+
`find_MAP` should not be used to initialize the NUTS sampler. Simply call
55+
``pymc3.sample()`` and it will automatically initialize NUTS in a better
56+
way.
5657
5758
Parameters
5859
----------
@@ -79,10 +80,10 @@ def find_MAP(
7980
8081
Notes
8182
-----
82-
Older code examples used find_MAP() to initialize the NUTS sampler,
83+
Older code examples used `find_MAP` to initialize the NUTS sampler,
8384
but this is not an effective way of choosing starting values for sampling.
8485
As a result, we have greatly enhanced the initialization of NUTS and
85-
wrapped it inside pymc3.sample() and you should thus avoid this method.
86+
wrapped it inside ``pymc3.sample()`` and you should thus avoid this method.
8687
"""
8788
model = modelcontext(model)
8889

0 commit comments

Comments
 (0)