Support

Troubleshooting

First, we need to know whether a problem is actually a bug in the code, or that it’s caused by something else, such as your local environment. The first step is to create a new environment with a fresh installation. In many cases, the problem will be resolved by this step.

Frequent issues

TypeError: _plot_histogram() got an unexpected keyword argument ‘title’

This error occurs when using outdated versions of the package.

Ensure that you are using the latest version, and when in a notebook, ensure that you’ve restarted the kernel when needed! Also make sure that you install in the right environment (please use !{sys.executable} -m pip install -U pandas-profiling!). Read more on this page: ‘Installing Python Packages from a Jupyter Notebook’.

Related issues: [950] [939] [528] [485] [396]

Conda install defaults to v1.4.1

Some users experience that conda install -c conda-forge pandas-profiling defaults to 1.4.1.

More details, [22], [448] and [563].

If creating a new environment with a fresh installation does not resolve this issue, or you have good reason to persist with the current environment, then you could try installing a specific version e.g. conda install -c conda-forge pandas-profiling=2.10.0. If it fails with an UnsatisfiableError that suggests dependant packages are either missing or incompatible, then further intervention is required to resolve the environment issue. However, conda error messages in this regard may be too cryptic or insufficient to pinpoint the culprit, therefore you may have to resort to an alternate means of troubleshooting e.g using the Mamba Package Manager. For an illustration of this approach see here.

Jupyter “IntSlider(value=0)”

When in a Jupyter environment, you see some text, such as IntSlider(value=0) or interactive (children=(IntSlider(value=0, description='x', max=1), Output()), _dom_classes=('widget-interact',)), then the Jupyter Widgets are not activated. The Installation page contains instructions on how to resolve this problem.

Help on Stackoverflow

Users with a request for help on how to use pandas-profiling should consider asking their question on stackoverflow. There is a specific tag for pandas-profiling:

Questions: Stackoverflow "pandas-profiling"

Slack community

Join the Slack community and come into contact with other users and developers, that might be able to answer your questions.

Reporting a bug

Next, we want 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 crafting a minimal bug report. Please include:

  • the minimal code you are using to generate the report

  • Which environment you are using. Version information is essential in reproducing and resolving bugs. Please report relevant environment details such as:

    • operating system (e.g. Windows, Linux, Mac)

    • Python version (e.g. 3.7)

    • 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()) Please share your dataframe. If the data 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 (df.info()) You should provide the DataFrame structure, for example by reporting the output of `df.info().

Issue formatting