Skip to content

Help & Troubleshooting

Troubleshooting

To start troubleshooting, we need to trace the issue to a bug in the code or to something else (such as your local environment). The first step is to create a new environment with a fresh installation (see Installation guide for instructions). In many cases, the problem will be resolved by this step.

If the problem can be replicated in the new environment, then it likely is a software bug. Before proceeding, check common_issues to check whether it is a previously identified common issue.

Reporting a bug

To ensure the bug was not already reported by searching on Github under Issues. If you\'re unable to find an open issue addressing the problem, open a new one. If possible, use the relevant bug report templates to create the issue.

You should provide the minimal information to reproduce this bug. This guide can help in crafting a minimal bug report. Please include:

  • The minimal code you are using to generate the report

  • Version information is essential in reproducing and resolving bugs. Include relevant environment details such as:

    • operating system (e.g. Windows, Linux, Mac)
    • Python version (e.g. 3.7)
    • Interface: Jupyter notebook (or cloud services like Google Colab, Kaggle Kernels, etc), console or IDE (such as PyCharm,VS Code,etc)
    • package manager (e.g. pip --version or conda info)
    • packages (pip freeze > packages.txt or conda list). Please make sure this is contained in a collapsed section (instructions below)

  • a sample of the dataset (df.sample() or df.head()). If the dataset is confidential, for example when it contains company-sensitive information, provide us with a synthetic or open dataset that produces the same error. You can anonymize the column names if necessary.

  • a description of the dataset and its structure, for example by reporting the DataFrame\'s structure through the output of df.info().

Issue formatting

To craft helpful and easily readable issues, two formatting tricks are recommended:

Using Stack Overflow

Users with a request for help on how to use ydata-profiling should consider asking their question on Stack Overflow, under the dedicated ydata-profiling tag:

Questions: Stackoverflow \"ydata-profiling\" or, Questions: Stackoverflow \"ydata-profiling\"

for questions about ydata-profiling older versions.

Discord community

Join the Discord community to connect with both other users and developers that might be able to answer your questions. The #ydata-profiling and #need-help channels are recommended for questions and issues.