Docs: Update notebook installation guideline from ydata_profiling

[simonespa]

Current Behaviour

I get a ModuleNotFoundError: No module named 'ydata_profiling' error message in Jupyter notebook when I import the ydata-profiling module.

The package version is 4.8.3 and I installed it with pip.

Expected Behaviour

I would expect for the module to be found.

Code that reproduces the bug

Install the dependency using pip. Either

pip install ydata-profiling

or

pip install 'ydata-profiling[notebook]'

Then run it in a Jupyterlab environment

from ydata_profiling import ProfileReport

ydata-profiling version

v4.8.3

Dependencies

Using Python v3.11.7 and pip v24.0, with the following dependencies
- pandas==2.2.2
- notebook==7.2.0
- jupyterlab==4.2.0
- ydata-profiling==4.8.3

OS

macOS Sonoma v14.4.1 (Darwin Kernel Version 23.4.0 x86_64)

Checklist

• There is not yet another bug report for this issue in the issue tracker
• The problem is reproducible from this bug report. This guide can help to craft a minimal bug report.
• The issue has not been resolved by the entries listed under Common Issues.

Similar issue

#1530

[simonespa]

For further info, I did ask with #1530 (comment) whether the resolution of #1530 (which is now closed) applies when using pip, given I still get the error.

Thanks for your time.

[simonespa]

I thought that it could have been an issue with the latest version of ydata-profiling, but I tried to install all the previous major versions listed here https://pypi.org/project/ydata-profiling/#history and I get the same error.

This suggests an issue not on the latest version of the profiler per-se, but rather an issue with the other dependencies, maybe with the latest versions of Jupyter?

[simonespa]

I'm following the documentation at https://docs.profiling.ydata.ai/latest/getting-started/installation/ and both the steps are failing.

By running !{sys.executable} -m pip install -U ydata-profiling[notebook] I get the following error:

no matches found: ydata-profiling[notebook]

This happens because pip doesn't recognise the square brackets. The package should use quotes like this 'ydata-profiling[notebook]', so pip can parse the whole string as a package name and pull the required libraries.

Also, the command doesn't need to import sys, you could simplify the command with this !pip install -U 'ydata-profiling[notebook]'.

Furthermore, the !jupyter nbextension enable --py widgetsnbextension command fails because nbextension is not a valid subcommand in the latest version of Jupyter.

[fabclmnt]

Hi @simonespa ,

feel free to contribute directly to our documentation! Thank you for all the improvements pointed out :)

[sigeek]

Hi, is there any update on this?
Getting same error: ModuleNotFoundError: No module named 'ydata_profiling'

Dependencies

- python==3.10.6
- jupyterlab==4.2.0
- ydata-profiling==4.8.3

I tried the following:

!pip install -U 'ydata-profiling'
!pip install -U 'ydata-profiling[notebook]'

[fabclmnt]

Hi @simonespa and @sigeek ,

answered here #1530. To install the package make use of the following commands :

pip install ydata-profiling
or
conda install -c conda-forge ydata-profiling

In the meantime we will be updating the documentation and remove the following instruction:
pip install -U ydata-profiling[notebook]

[simonespa]

Hi @fabclmnt

Thanks for your prompt response.

The profiler is now working again and I'm not getting the previous error. I wonder whether there was some dependency issue with the Notebook version.

Feel free to link the PR for the doc update here and close this.

Thanks for your help.