Skip to content

Commit c9cecfb

Browse files
committed
readme and docs correction
1 parent 34c7894 commit c9cecfb

4 files changed

Lines changed: 32 additions & 9 deletions

File tree

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,31 @@
1010
[![Build Status](https://github.com/data-centt/percentify/actions/workflows/python-app.yml/badge.svg)](https://github.com/data-centt/percentify/actions/workflows/python-app.yml)
1111
[![Polars](https://img.shields.io/badge/Polars-supported-cd792c?style=flat)](https://data-centt.github.io/percentify/)
1212

13-
**Percentify is a data science library that turns the 20% of data science operations behind 80% of daily work into single, readable function calls.**
13+
**80% of the checks you run on every dataset. 20% of the code.**
1414

15-
**⚡ Full Polars DataFrame support:** pass a polars DataFrame or Series and get the same kind back, no flag needed.
15+
Exploratory stats and data-quality diagnostics for pandas and **Polars** DataFrames. One call each.
1616

17+
> [!TIP]
18+
> **⚡ Polars is first-class, not an afterthought.** Pass a Polars DataFrame or Series and get the same kind straight back, with no flag and no manual conversion. Every function works on both backends, which is what sets Percentify apart from the pandas-only tools.
1719
18-
Built on pandas and numpy, it pairs everyday hard to reach tools with lesser-known ones. Where a function wraps an existing library (pandas, scipy, statsmodels, scikit-learn), it names it, so you always know where to dig deeper.
20+
Where a function wraps an existing library (pandas, scipy, statsmodels, scikit-learn), it names it, so you always know where to dig deeper.
21+
22+
## ⭐ The flagship: `profiler`
23+
24+
**pandas `.describe()` tells you what your data _is_. `profiler()` tells you what to _do_ about it:** every issue ranked worst-first, each with its fix.
25+
26+
```python
27+
from percentify import profiler
28+
29+
report = profiler(df, target="churn")
30+
31+
report.to_frame() # every finding, ranked worst-first, with a suggested fix
32+
report.errors # just the blocking issues
33+
report.health # a 0 to 100 data-health score
34+
assert not report.errors # drop it straight into a CI data-quality gate
35+
```
36+
37+
Point it at any messy DataFrame, pandas or Polars, and see what it flags before you model. [Try it on your own data →](https://data-centt.github.io/percentify/documentation/#profiler)
1938

2039
## 📖 Documentation
2140

docs/documentation.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ polars stays optional: it is only imported when you actually pass a polars objec
4747

4848
## `profiler`
4949

50-
The flagship: a one-call **data diagnostician**. Instead of dumping statistics for every column, it runs a battery of checks, ranks the problems worst-first, scores the data's health, and tells you how to fix each issue. It composes the rest of the toolkit (`missing`, `imbalance`, and more) under one entry point.
50+
The flagship, a one-call **data diagnostician**. pandas `.describe()` tells you what your data *is*; `profiler()` tells you what to *do* about it: every issue ranked worst-first, each with its fix. Instead of dumping statistics for every column, it runs a battery of checks, scores the data's health, and composes the rest of the toolkit (`missing`, `imbalance`, and more) under one entry point.
5151

5252
!!! tip "Similar concept"
5353
`ydata-profiling` / `pandas.DataFrame.describe`, but diagnostic (it ranks problems and suggests fixes) rather than descriptive.
@@ -94,6 +94,9 @@ The report renders as a compact, color-coded summary in notebooks and terminals,
9494

9595
Pass `target=` to also check for **leakage** (features that predict the target almost perfectly) and class imbalance. Accepts pandas or polars input.
9696

97+
!!! example "Try it on your own data"
98+
Point `profiler()` at any messy dataset you have lying around, pandas or Polars, and read the findings top to bottom. It is the fastest way to see what to fix before you model.
99+
97100
---
98101

99102
## `change`

docs/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@
44

55

66

7-
*The 20% of data science operations behind 80% of daily work: each a single, readable function call.*
7+
**80% of the checks you run on every dataset. 20% of the code.**
88

9-
**⚡ Full Polars DataFrame support:** pass a polars DataFrame or Series and get the same kind back, no flag needed.
9+
Exploratory stats and data-quality diagnostics for pandas and **Polars** DataFrames. One call each.
1010

11-
Following the *Pareto principle*, Percentify brings the checks you run on every dataset to the forefront, one call at a time. No more digging through six-line recipes and hard-to-remember import paths.
11+
!!! tip "⚡ Polars is first-class, not an afterthought"
12+
Pass a Polars DataFrame or Series and get the same kind straight back, with no flag and no manual conversion. Every function works on both backends, which is what sets Percentify apart from the pandas-only tools.
1213

13-
Built on pandas and numpy, it pairs the everyday tools you reach for constantly with lesser-known ones worth knowing. Where a function wraps an existing library (pandas, scipy, statsmodels, scikit-learn), it names it, so you always know where to dig deeper.
14+
Where a function wraps an existing library (pandas, scipy, statsmodels, scikit-learn), it names it, so you always know where to dig deeper.
1415

1516
---
1617

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
site_name: Percentify
2-
site_description: A niche data science library that brings the 80% of daily data tasks to the forefront.
2+
site_description: Exploratory stats and data-quality diagnostics for pandas and Polars DataFrames. One call each.
33
site_url: https://data-centt.github.io/percentify/
44
repo_url: https://github.com/data-centt/percentify
55
repo_name: data-centt/percentify

0 commit comments

Comments
 (0)