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.

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

Patch optional imports, documented predictor categorization, revamped docs #293

Merged
merged 29 commits into from
Dec 9, 2024
Merged
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
b6116e4
add pre-commit to dev deps, update docs
StijnKas Nov 15, 2024
77e971a
update docs workflows
StijnKas Nov 15, 2024
413eea1
try updated docs workflow
StijnKas Nov 15, 2024
d58cc30
see effects on docs
StijnKas Nov 15, 2024
82fb200
try to ignore loggers
StijnKas Nov 15, 2024
b870799
Merge branch 'pegasystems:master' into master
StijnKas Nov 18, 2024
8478d94
doc revamp
StijnKas Nov 18, 2024
c7e831a
keep using doc push on every push while deving
StijnKas Nov 18, 2024
b13a156
sphinxarg as dependency
StijnKas Nov 18, 2024
35f48b1
more conditions
StijnKas Nov 18, 2024
c145abb
Bring back jupyter tags
StijnKas Nov 18, 2024
7ccf716
bring back vf cell tag too
StijnKas Nov 18, 2024
c4893b7
update predictor_binning
StijnKas Nov 18, 2024
8aeda3b
update agb
StijnKas Nov 18, 2024
74591d9
Update VF article
StijnKas Nov 18, 2024
1b7751c
update admexplained
StijnKas Nov 18, 2024
e86fec5
Add getting started guide
StijnKas Nov 18, 2024
7457727
Further docstring improvements
StijnKas Nov 18, 2024
715527e
Fix tests
StijnKas Nov 18, 2024
f31282a
don't import from python
StijnKas Nov 18, 2024
33ade6e
Add inline dependencies to the cli
StijnKas Nov 18, 2024
e2c4356
Delete uv.lock
StijnKas Nov 19, 2024
713af9e
update release ci to use pypi token
StijnKas Nov 19, 2024
d12999a
try v5 :)
StijnKas Nov 19, 2024
c99ca38
skip one test
StijnKas Nov 19, 2024
80b7689
Release docs on public version release
StijnKas Nov 19, 2024
e2a2bfb
Fixed optional imports, documented predictor categorization
StijnKas Dec 9, 2024
a9bbd31
Merge branch 'master' into patch
StijnKas Dec 9, 2024
76b616c
tie polars to 1.16 - it was failing
StijnKas Dec 9, 2024
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
see effects on docs
  • Loading branch information
StijnKas committed Nov 15, 2024
commit d58cc30efbc3b7ea572dece13d2c41aac6d8e71e
10 changes: 8 additions & 2 deletions python/pdstools/adm/ADMDatamart.py
Original file line number Diff line number Diff line change
@@ -51,15 +51,15 @@ class ADMDatamart:
The Polars LazyFrame represenation of the predictor binning table.
query : QUERY, optional
An optional query to apply to the input data.
For details, see :meth:`pdstools.cdh_utils._apply_query`.
For details, see :meth:`pdstools.utils.cdh_utils._apply_query`.
extract_pyname_keys : bool, default = True
Whether to extract extra keys from the `pyName` column.

See Also
--------
pdstools.adm.Plots : The out of the box plots to run.
pdstools.adm.Reports : The Health Check and Model Report files to generate.
pdstools.cdh_utils._apply_query : The internal query mechansm to filter the data.
pdstools.utils.cdh_utils._apply_query : The internal query mechansm to filter the data.

Examples
--------
@@ -78,6 +78,12 @@ class ADMDatamart:
model_data: Optional[pl.LazyFrame]
predictor_data: Optional[pl.LazyFrame]
combined_data: Optional[pl.LazyFrame]
plot: Plots
aggregates: Aggregates
agb: AGB
generate: Reports
cdh_guidelines: CDHGuidelines
bin_aggregator: BinAggregator

def __init__(
self,