pymc-labs / pymc-marketing

Bayesian marketing toolbox in PyMC. Media Mix (MMM), customer lifetime value (CLV), buy-till-you-die (BTYD) models and more.
https://www.pymc-marketing.io/
Apache License 2.0
663 stars 183 forks source link

#1020 Correction of doctring for plot.py for `sample_kwargs` #1060

Closed Ishaanjolly closed 4 days ago

Ishaanjolly commented 5 days ago
Just changed `plot_curves` to `plot_samples` ## Description Sample Kwargs now has plot_samples instead of plot_curve - ``` curve : xr.DataArray Curve to plot non_grid_names : set[str] The names to exclude from the grid. HDI and samples both have defaults of hdi and chain, draw, respectively subplot_kwargs : dict, optional Addtional kwargs to while creating the fig and axes sample_kwargs : dict, optional Kwargs for the :func:`plot_sample` function hdi_kwargs : dict, optional Kwargs for the :func:`plot_hdi` function same_axes : bool If all of the plots are on the same axis colors : Iterable[str], optional Colors for the plots legend : bool, optional If to include a legend. Defaults to True if same_axes sel_to_string : Callable[[Selection], str], optional Function to convert selection to a string. Defaults to ", ".join(f"{key}={value}" for key, value in sel.items()) ``` ## Related Issue

Checklist

Modules affected

Type of change


📚 Documentation preview 📚: https://pymc-marketing--1060.org.readthedocs.build/en/1060/

codecov[bot] commented 5 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 37.51%. Comparing base (f70db33) to head (5c681b1).

:exclamation: There is a different number of reports uploaded between BASE (f70db33) and HEAD (5c681b1). Click for more details.

HEAD has 2 uploads less than BASE | Flag | BASE (f70db33) | HEAD (5c681b1) | |------|------|------| ||3|1|
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1060 +/- ## =========================================== - Coverage 95.85% 37.51% -58.34% =========================================== Files 39 39 Lines 3934 3934 =========================================== - Hits 3771 1476 -2295 - Misses 163 2458 +2295 ``` | [Flag](https://app.codecov.io/gh/pymc-labs/pymc-marketing/pull/1060/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pymc-labs) | Coverage Δ | | |---|---|---| | [](https://app.codecov.io/gh/pymc-labs/pymc-marketing/pull/1060/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pymc-labs) | `37.51% <ø> (?)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pymc-labs#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

juanitorduz commented 4 days ago

Thanks @Ishaanjolly