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

PSI blurb in Docs for 0.8.3 #714

Merged
merged 6 commits into from
Nov 10, 2022
Merged
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions docs/source/profiler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,12 @@ between them. Create the difference report like this:
diff_report = profile1.diff(profile2)
print(diff_report)

The `.diff()` operation is available between two profiles, although there are different
outputs depending on the type of profile being differenced. For example, for numerical
column profiles (e.g. integers and floats), two valuable calculations that
`.diff()` returns are `t-test` and `psi` (Popoulation Stability Index)
for understanding distributional changes.

The difference report contains a dictionary that mirrors the profile report.
Each data type has its own difference:

Expand Down Expand Up @@ -208,6 +214,7 @@ Below is the structured difference report:
'p-value': float},
'welch': {'df': float,
'p-value': float}},
'psi': float,
"chi2-test": {
"chi2-statistic": float,
"df": int,
Expand Down