docs: add student exam performance profiling example notebook - #1862
Conversation
fabclmnt
left a comment
There was a problem hiding this comment.
Thanks for contributing! Another example is always welcome, but I have a few asks.
Naming and layout: examples are organised one folder per dataset,
examples//.ipynb (see titanic/, meteorites/,
usaairquality/). Analysis_0.ipynb doesn't say what the example does.
Please move it to examples/student_exam_performance/student_exam_performance.ipynb.
Package: the notebook installs and imports ydata-profiling from PyPI,
which is older package, not this one. Examples must exercise
this repo: from data_profiling import ProfileReport, and drop the
!pip install cell or updated it to use the correct package from pypi - https://pypi.org/project/fg-data-profiling/.
Dataset: we can only ship examples on datasets with an explicit
permissive licence. Please state the licence of the Kaggle dataset in
the PR; it isn't visible on the public page, and re-uploads often
can't be relicensed by the uploader. kagglehub is also a problem on
its own, as it requires Kaggle credentials, so the notebook isn't
runnable for most users or in CI. Use the existing loader with a
stable public URL:
from data_profiling.utils.cache import cache_file
file_name = cache_file("student_performance.csv", "<url>")
If the license can't be confirmed, UCI's Student Performance dataset
(Cortez & Silva) is CC BY 4.0 and covers the same ground.
One more: the insights cell reads mental-health variables as
affecting outcomes. Keep example commentary to what the profile
shows, distributions, missingness, correlations, without causal
claims.
|
Hi @fabclmnt, thank you again for the detailed and constructive review!
Please let me know if there’s anything else I should adjust. Thanks again for the guidance! |
…t-performance-example
Description
This PR adds a new example notebook demonstrating how to use
fg-data-profilingon the UCI Student Performance dataset.Why this is useful
I noticed the examples folder could benefit from a demonstration using an educational dataset. This notebook shows how to:
cache_fileutility for seamless reproducibility in CI (no external credentials required).Dataset & Licensing
kagglehubcredentials.Checklist
data_profiling.utils.cache.cache_file.from data_profiling import ProfileReport(noydata-profilingreferences).examples/student_exam_performance/student_exam_performance.ipynb.Thank you for reviewing! Let me know if any further changes or adjustments are needed.