bambinos / bambi

BAyesian Model-Building Interface (Bambi) in Python.
https://bambinos.github.io/bambi/
MIT License
1.08k stars 124 forks source link

Change `plots` submodule name to `interpret` #705

Closed GStechschulte closed 1 year ago

GStechschulte commented 1 year ago

This PR changes the plots submodule name to interpret as the functions in this sub package are not limited to plotting functions only. Additionally, this draft PR aims exposes the sub package functions in the main Bambi package to allow imports such as

import bambi as bmb

bmb.interpret.predictions()
# or
bmb.interpret.plot_predictions()

Any referencing files, documentation, and tests have been edited to reflect this change.

Note: this branch was a checkout of the branch for PR #704 (once PR 704 is merged, then this can be merged).

review-notebook-app[bot] commented 1 year ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

aloctavodia commented 1 year ago

I think the errors come from this line

https://github.com/bambinos/bambi/blob/main/pyproject.toml#L61C20-L61C20

as that directory no longer exists

GStechschulte commented 1 year ago

I think the errors come from this line

https://github.com/bambinos/bambi/blob/main/pyproject.toml#L61C20-L61C20

as that directory no longer exists

Ahh yes, thanks for the hint 👍🏼

codecov-commenter commented 1 year ago

Codecov Report

Merging #705 (b4d4720) into main (5dde496) will decrease coverage by 0.08%. The diff coverage is 84.61%.

@@            Coverage Diff             @@
##             main     #705      +/-   ##
==========================================
- Coverage   89.57%   89.50%   -0.08%     
==========================================
  Files          43       44       +1     
  Lines        3522     3526       +4     
==========================================
+ Hits         3155     3156       +1     
- Misses        367      370       +3     
Files Changed Coverage Δ
bambi/interpret/utils.py 86.76% <ø> (ø)
bambi/plots/__init__.py 0.00% <0.00%> (-100.00%) :arrow_down:
bambi/__init__.py 76.47% <100.00%> (+1.47%) :arrow_up:
bambi/interpret/__init__.py 100.00% <100.00%> (ø)
bambi/interpret/create_data.py 100.00% <100.00%> (ø)
bambi/interpret/effects.py 89.24% <100.00%> (ø)
bambi/interpret/plot_types.py 73.39% <100.00%> (ø)
bambi/interpret/plotting.py 84.96% <100.00%> (ø)

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

tomicapretto commented 1 year ago

@GStechschulte if I merge this, there's no need to merge #704, right?

edit I merged and created conflicts :sweat_smile: , I will fix them

GStechschulte commented 1 year ago

@GStechschulte if I merge this, there's no need to merge #704, right?

edit I merged and created conflicts 😅 , I will fix them

Just let me know if I should do something. It is also my fault. I created excess work with PR #704 since it could have all been in one PR.

tomicapretto commented 1 year ago

@GStechschulte if I merge this, there's no need to merge #704, right? edit I merged and created conflicts 😅 , I will fix them

Just let me know if I should do something. It is also my fault. I created excess work with PR #704 since it could have all been in one PR.

no worries! It's fixed now