Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docstrings of ess, autocorr and bpv plots #2185

Merged
merged 16 commits into from
Jan 5, 2023
Merged

Update docstrings of ess, autocorr and bpv plots #2185

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
2a3256d
Update plot_ess documentation
asael697 Dec 21, 2022
1aad4f1
Update essplot.py
asael697 Dec 28, 2022
df3043d
Update autocorrplot.py
asael697 Dec 28, 2022
44edd04
Update autocorrplot.py
asael697 Dec 28, 2022
07c8878
Update bpvplot.py
asael697 Dec 28, 2022
0db3900
Update arviz/plots/bpvplot.py
asael697 Dec 29, 2022
7c05997
Update arviz/plots/bpvplot.py
asael697 Dec 29, 2022
7a59531
Update arviz/plots/bpvplot.py
asael697 Dec 29, 2022
ac96e68
Update arviz/plots/essplot.py
asael697 Dec 29, 2022
39e4c71
Update arviz/plots/autocorrplot.py
asael697 Dec 29, 2022
bded828
Update autocorrplot.py
asael697 Jan 2, 2023
d16dc7d
Update bpvplot.py
asael697 Jan 2, 2023
9fc2084
Update bpvplot.py
asael697 Jan 2, 2023
d862c2a
Update essplot.py
asael697 Jan 2, 2023
447a4e0
Update essplot.py
asael697 Jan 2, 2023
4d99af5
fixes to docstrings
OriolAbril Jan 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update autocorrplot.py 
update `plot_autocor()` function
  • Loading branch information
@asael697 @OriolAbril
asael697 authored and OriolAbril committed Jan 2, 2023
commit bded82871d3decca9d10b08071719f45697c1bf7
8 changes: 4 additions & 4 deletions arviz/plots/autocorrplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ def plot_autocorr(

Parameters
----------
data : obj
data : InferenceData
Any object that can be converted to an :class:`arviz.InferenceData` object
refer to documentation of :func:`arviz.convert_to_dataset` for details
var_names : list of str, optional
Variables to be plotted. Prefix the variables by ``~`` when you want to exclude
them from the plot. See the :ref:`this section <common_var_names>` for usage examples.
filter_vars : {None, "like", "regex"}, default None
filter_vars : {None, "like", "regex"}, default None
If `None` (default), interpret `var_names` as the real variables names. If "like",
interpret `var_names` as substrings of the real variables names. If "regex",
interpret `var_names` as regular expressions on the real variables names. See
Expand All @@ -50,12 +50,12 @@ def plot_autocorr(
grid : tuple, optional
Number of rows and columns. Defaults to None, the rows and columns are
automatically inferred.
figsize : tuple, optional
figsize : (float, float), optional
Figure size. If None it will be defined automatically.
Note this is not used if ``ax`` is supplied.
textsize : float, optional
Text size scaling factor for labels, titles and lines. If None it will be autoscaled based
on ``figsize``.
on `figsize`.
labeller : Labeller, optional
Class providing the method ``make_label_vert`` to generate the labels in the plot titles.
Read the :ref:`label_guide` for more details and usage examples.
Expand Down