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

Create examples for the column associations metrics #1181

Closed
reshamas opened this issue Dec 6, 2024 · 2 comments
Closed

Create examples for the column associations metrics #1181

reshamas opened this issue Dec 6, 2024 · 2 comments
Assignees
Labels
documentation Add or improve the documentation no changelog needed

Comments

@reshamas
Copy link
Contributor

reshamas commented Dec 6, 2024

Describe the issue linked to the documentation

https://skrub-data.org/stable/reference/generated/skrub.column_associations.html

Metrics:

  • Cramer’s V statistic
  • other metrics

Working example from pandas:

Suggest a potential alternative/fix

No response

@jeromedockes
Copy link
Member

to recap what we said yesterday: the column_associations function is missing an "Examples" section in its docstring. It would be great to add a small example section to show generating the associations for a toy example dataframe, so users can see how to call it and what would be the shape and content of the output. something like

Examples
--------
>>> import pandas as pd
>>> from skrub import column_associations
>>> df = ...
>>> column_associations(df)
       ...

@jeromedockes
Copy link
Member

I'll mark this one as completed: when more association metrics are added they will show up in the output of the example added in #1186

When we add more metrics we will also update the documentation to include a short paragraph and wikipedia link for each.

To be continued in #1176 ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Add or improve the documentation no changelog needed
Projects
Development

No branches or pull requests

2 participants