Skip to content

docs: add simple example of ProfileReport usage #1789

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.

Sign up for GitHub

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

Open
kdlocks wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

docs: add simple example of ProfileReport usage #1789

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
adda739
Docs: add simple example of ProfileReport usage
kdlocks Nov 21, 2025
a91fd6c
Merge branch 'develop' into docs/add-simple-example
kdlocks Nov 21, 2025
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
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,3 +268,21 @@ A big thank you to all our amazing contributors!
</a>

Contributors wall made with [contrib.rocks](https://contrib.rocks).
### Exemple d’utilisation simple

Voici un exemple minimal pour générer un rapport avec `ydata-profiling` :

```python
import pandas as pd
from ydata_profiling import ProfileReport

# Exemple de DataFrame simple
df = pd.DataFrame({
"Mois": ["Janvier", "Février", "Mars"],
"Ventes": [1200, 1500, 1700],
"Coût": [800, 900, 1000]
})

# Génération du rapport
profile = ProfileReport(df, title="Rapport de ventes", explorative=True)
profile.to_file("rapport_ventes.html")