Draft: feature/setup doctests #869

MuradKhalil · 2024-07-24T19:47:27Z

Description

added a make command to run code in docstrings

Related Issue

Closes Run example code in doc strings in CI #578
Related to #

Checklist

Checked that the pre-commit linting/style checks pass
Included tests that prove the fix is effective or that the new feature works
Added necessary documentation (docstrings and/or example notebooks)
If you are a pro: each commit corresponds to a relevant logical change

Modules affected

MMM
CLV

Type of change

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

* add scaling into lift test method * test scaling methods * test change of MMM likelihood * link up beta_channel parameters * change name to sigma * reorganize and edit * closes pymc-labs#406 * address the feedback in docstrings * add more to docstring * format the docstring * be verbose for future devs * be explicit for the column max values * incorporate the feedback * hide cells and add to intro * add conclusion * switch to header 2 * run notebook through * move the types together * separate model estimated from empirical * fix typos

* drop python 3.9 * try python 3.12 * undo try python 3.12

* improve nb * rm warnings and add link to lifetimes quickstart * address comments * feedback part 3 * remove warnings manually

* add more info to the notebook * hide plots code * fix plot y labels * fix plot outputs and remove model build * improve final note probability plots * address comments * use quickstart dataset * feedback part 3 * remowe warnings manually * feedback part 4

* improve mmm docs init * add more code examples to docstrings * minor improvemeents * typo * better phrasing * add thomas suggestion

* move fixtures to conftest * docstrings and moved set_model_fit to conftest * fixed pandas quickstart warnings * revert to MockModel and add ParetoNBD support * quickstart edit for issue 609 * notebook edit

remove ruff E501 ignore

updates: - [github.com/astral-sh/ruff-pre-commit: v0.3.5 → v0.3.7](astral-sh/ruff-pre-commit@v0.3.5...v0.3.7) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Juan Orduz <[email protected]>

* fix potential bugs * minor improvements * remove rule for nb * fix test * improve tests syntax * use stacklevel 2 for warnings * use stacklevel 1 for warnings as they are used in public methods * ignore B904 * undo change * ricardos feedback * use fit_posterior * Update pymc_marketing/clv/models/gamma_gamma.py Co-authored-by: Ricardo Vieira <[email protected]> * last fix XD --------- Co-authored-by: Ricardo Vieira <[email protected]>

* notebook opening and imports * model definition markdown * Data Load Notebook section * WIP model fitting section * added notebook to docs directory * notebook edits and graph code * ppc section and nb cleanup * demz sampling and WIP plotting * WIP predictive plots * WIP heatmap plots * predictive plots * WIP covariates and nbqa-ruff edits * covariate section * plot additions * fig sizes * remove model file

…book (pymc-labs#651) * add spaces, increase indentation, and fix number order * explicit with 6

* Creating plot waterfall Co-Authored-By: Carlos Trujillo <[email protected]> * requested changes * pre-commit --------- Co-authored-by: Carlos Trujillo <[email protected]>

Databricks should have a lower-case b.

updates: - [github.com/astral-sh/ruff-pre-commit: v0.4.1 → v0.4.2](astral-sh/ruff-pre-commit@v0.4.1...v0.4.2) - [github.com/pre-commit/mirrors-mypy: v1.9.0 → v1.10.0](pre-commit/mirrors-mypy@v1.9.0...v1.10.0) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* support for negative values and dates (if used) * fix terrible spelling * test dates in coords * cover numpy objects * consolidate the tests

* update uml diagrams * add uml command to Makefile

* updated the ruff lint command, added ruff code formating command in Makefile, updated contributing.md * fixing the issue with the new line at the end of makefile * updated the PHONY list in makefile --------- Co-authored-by: Murad Khalilov <[email protected]>

updates: - [github.com/pre-commit/mirrors-mypy: v1.10.1 → v1.11.0](pre-commit/mirrors-mypy@v1.10.1...v1.11.0) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Juan Orduz <[email protected]>

* Fix model_builder docstrings * Fix whitespace error --------- Co-authored-by: Juan Orduz <[email protected]>

* add GH discussions link to README * add link to MMM hub slack * Update README.md --------- Co-authored-by: Will Dean <[email protected]>

MuradKhalil · 2024-07-24T19:55:27Z

TODO: add this check to CI

…-labs#857) * Fix plotting by evaluating tensors. * Add space after sphinx directive. * Remove indentation from blank line. * Add shared y axis for subplots. --------- Co-authored-by: Patrick Robotham <[email protected]> Co-authored-by: Will Dean <[email protected]>

wd60622 · 2024-07-25T05:27:15Z

This will be awesome. Thanks for getting this started!

I'm not familiar with the tool. Is this an additional install? Will will have to add to our various environment locations then "environment.yml" / "pyproject.toml"(?), etc

TODO: add this check to CI

Might be good to run in parallel with other tests. WDYT?

* add original scale implementation * add plot nb * change location * undo * make mypy happy * test plot * add test * update plot readme * fix test * improve variable description

* infernece changed to dataset * inference changed dataset for plot_allocated_contribution_by_channel --------- Co-authored-by: Will Dean <[email protected]>

wd60622 · 2024-11-14T18:05:01Z

Hi @MuradKhalil
Are you still interested in working on this? If not, I can make some issues for this

wd60622 and others added 30 commits April 2, 2024 15:07

Drop python 3.9 support (pymc-labs#615)

8590b45

* drop python 3.9 * try python 3.12 * undo try python 3.12

add lift tests check

27a55d5

Add more content to the Gamma-Gamma Notebook (pymc-labs#573)

f3ec2cf

* improve nb * rm warnings and add link to lifetimes quickstart * address comments * feedback part 3 * remove warnings manually

Improve MMM Docs (pymc-labs#612)

da9f025

* improve mmm docs init * add more code examples to docstrings * minor improvemeents * typo * better phrasing * add thomas suggestion

Fix clv plotting bugs and edits to Quickstart (pymc-labs#601)

38b55a2

* move fixtures to conftest * docstrings and moved set_model_fit to conftest * fixed pandas quickstart warnings * revert to MockModel and add ParetoNBD support * quickstart edit for issue 609 * notebook edit

[pre-commit.ci] pre-commit autoupdate (pymc-labs#616)

ffef5a6

improve coords matching (pymc-labs#623)

a151330

python 3.12 attempt (pymc-labs#618)

6f33cef

closes pymc-labs#520 (pymc-labs#621) dataset -> data

c40c8b8

mmm example notebook small fixes (pymc-labs#626)

ff937f4

Remove ruff E501 ignore (pymc-labs#619)

e2dba27

remove ruff E501 ignore

Update pypi.yml (dash change) (pymc-labs#633)

b777eb5

UP rule ruff (pymc-labs#635)

2be2f63

Add ruff RUF rules (pymc-labs#636)

582d2ed

Update version.txt (pymc-labs#640)

78964f0

[pre-commit.ci] pre-commit autoupdate (pymc-labs#642)

18d926c

Fix build badge (pymc-labs#645)

ce41f5f

Add downloads stats to README

818781a

add spaces, increase indentation, and fix number order to Pareto note…

7034e28

…book (pymc-labs#651) * add spaces, increase indentation, and fix number order * explicit with 6

Add link to new Pareto notebook (pymc-labs#649)

d531d0c

Plot Waterfall Components Decomposition (pymc-labs#631)

1c186f0

* Creating plot waterfall Co-Authored-By: Carlos Trujillo <[email protected]> * requested changes * pre-commit --------- Co-authored-by: Carlos Trujillo <[email protected]>

Update resources.md (pymc-labs#652)

b36b0ac

Databricks should have a lower-case b.

fix ylabel (pymc-labs#654)

ae6ae1d

Lift test fixes (#656)

a89bd93

* support for negative values and dates (if used) * fix terrible spelling * test dates in coords * cover numpy objects * consolidate the tests

drbenvincent and others added 7 commits July 23, 2024 17:19

Update UML diagrams (pymc-labs#856)

8234c4b

* update uml diagrams * add uml command to Makefile

Fix model_builder docstrings (pymc-labs#861)

b10f1f1

* Fix model_builder docstrings * Fix whitespace error --------- Co-authored-by: Juan Orduz <[email protected]>

add GH discussions link to README (pymc-labs#866)

b7b97e7

* add GH discussions link to README * add link to MMM hub slack * Update README.md --------- Co-authored-by: Will Dean <[email protected]>

added a make command to run doctests

ead8924

updated contributing.md

0fd273a

MuradKhalil closed this Jul 24, 2024

MuradKhalil reopened this Jul 24, 2024

MuradKhalil closed this Jul 24, 2024

MuradKhalil reopened this Jul 24, 2024

MuradKhalil changed the title ~~Feature/setup doctests~~ Draft: feature/setup doctests Jul 24, 2024

Murad Khalilov and others added 3 commits July 24, 2024 22:08

updated the list of commands in the phony list in the makefile

e1f840f

Skip coords with scalar value (pymc-labs#868)

8ee9254

wd60622 added maintenance devops labels Jul 25, 2024

Merge branch 'main' into feature/setup_doctests

66d5750

juanitorduz and others added 3 commits July 25, 2024 13:58

Allow plot MMM components in the original scale (pymc-labs#870)

de5679f

* add original scale implementation * add plot nb * change location * undo * make mypy happy * test plot * add test * update plot readme * fix test * improve variable description

Inference changed to dataset (pymc-labs#873)

19aea61

* infernece changed to dataset * inference changed dataset for plot_allocated_contribution_by_channel --------- Co-authored-by: Will Dean <[email protected]>

Merge branch 'main' into feature/setup_doctests

e291170

wd60622 marked this pull request as draft July 25, 2024 16:17

ulfaslak force-pushed the main branch 4 times, most recently from f9a38fd to 818ba39 Compare September 8, 2024 12:38

twiecki force-pushed the main branch from 35dc7f1 to 9f9c67f Compare September 10, 2024 15:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Draft: feature/setup doctests #869

Draft: feature/setup doctests #869

MuradKhalil commented Jul 24, 2024 •

edited by github-actions bot

Loading

MuradKhalil commented Jul 24, 2024

wd60622 commented Jul 25, 2024 •

edited

Loading

wd60622 commented Nov 14, 2024

Draft: feature/setup doctests #869

Are you sure you want to change the base?

Draft: feature/setup doctests #869

Conversation

MuradKhalil commented Jul 24, 2024 • edited by github-actions bot Loading

Description

Related Issue

Checklist

Modules affected

Type of change

MuradKhalil commented Jul 24, 2024

wd60622 commented Jul 25, 2024 • edited Loading

wd60622 commented Nov 14, 2024

MuradKhalil commented Jul 24, 2024 •

edited by github-actions bot

Loading

wd60622 commented Jul 25, 2024 •

edited

Loading