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.

Sign up for GitHub

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

Jump to bottom

docs: update and fix documentatio and package examples #1621

Merged
merged 4 commits into from
Jul 12, 2024
Merged

docs: update and fix documentatio and package examples #1621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1314e0d
docs: update and fix documentatio and package examples
Jul 12, 2024
3eeab5e
fix(linting): code formatting
azory-ydata Jul 12, 2024
391e6c6
chore: remove unused file
Jul 12, 2024
9027235
Merge remote-tracking branch 'origin/docs/update_install_examples_doc…
Jul 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,13 @@ If you are in a notebook (locally, LambdaLabs, Google Colab or Kaggle), you can
```python linenums="1"
import sys
!{sys.executable} -m pip install -U ydata-profiling[notebook]
!jupyter nbextension enable --py widgetsnbextension
!pip install jupyter-contrib-nbextensions
```
Afterwards you can run the following command

```python linenums="1"
!jupyter nbextension enable --py widgetsnbextension
```
You may have to restart the kernel or runtime for the package to work.

## Using conda
Expand Down
35 changes: 1 addition & 34 deletions examples/integrations/ydata_fabric_pipelines/data_profiling.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,6 @@
"start_time": "2022-10-24T06:29:02.519523",
"status": "completed"
},
"pycharm": {
"name": "#%% md\n"
},
"tags": []
},
"source": [
Expand All @@ -31,9 +28,6 @@
"start_time": "2022-10-24T06:29:02.636283",
"status": "completed"
},
"pycharm": {
"name": "#%% md\n"
},
"tags": []
},
"source": [
Expand All @@ -57,9 +51,6 @@
"start_time": "2022-10-24T06:29:02.737117",
"status": "completed"
},
"pycharm": {
"name": "#%% md\n"
},
"tags": []
},
"source": [
Expand All @@ -77,9 +68,6 @@
"start_time": "2022-10-24T06:29:06.291913",
"status": "completed"
},
"pycharm": {
"name": "#%% md\n"
},
"tags": []
},
"source": [
Expand All @@ -98,9 +86,6 @@
"start_time": "2022-10-24T06:29:06.401327",
"status": "completed"
},
"pycharm": {
"name": "#%%\n"
},
"tags": []
},
"outputs": [],
Expand All @@ -127,14 +112,11 @@
"start_time": "2022-10-24T06:29:08.641388",
"status": "completed"
},
"pycharm": {
"name": "#%%\n"
},
"tags": []
},
"outputs": [],
"source": [
"dataset = DataSources.get(uid=\"973d95c7-e6bd-4535-a0ea-d3dd1e893b13\").read()"
"dataset = DataSources.get(uid=\"insert-uid\").read()"
]
},
{
Expand All @@ -149,9 +131,6 @@
"start_time": "2022-10-24T06:29:14.867782",
"status": "completed"
},
"pycharm": {
"name": "#%%\n"
},
"tags": []
},
"outputs": [],
Expand All @@ -171,9 +150,6 @@
"start_time": "2022-10-24T06:29:15.001031",
"status": "completed"
},
"pycharm": {
"name": "#%% md\n"
},
"tags": []
},
"source": [
Expand All @@ -192,9 +168,6 @@
"start_time": "2022-10-24T06:29:15.107441",
"status": "completed"
},
"pycharm": {
"name": "#%%\n"
},
"tags": []
},
"outputs": [],
Expand All @@ -215,9 +188,6 @@
"start_time": "2022-10-24T06:29:15.322696",
"status": "completed"
},
"pycharm": {
"name": "#%%\n"
},
"tags": []
},
"outputs": [],
Expand All @@ -244,9 +214,6 @@
"start_time": "2022-10-24T06:29:51.135648",
"status": "completed"
},
"pycharm": {
"name": "#%%\n"
},
"tags": []
},
"outputs": [],
Expand Down
3 changes: 2 additions & 1 deletion examples/meteorites/meteorites.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@
"source": [
"import sys\n",
"\n",
"!{sys.executable} -m pip install -U pandas-profiling[notebook]\n",
"!{sys.executable} -m pip install -U ydata-profiling[notebook]\n",
"!pip install jupyter-contrib-nbextensions\n",
"!jupyter nbextension enable --py widgetsnbextension"
]
},
Expand Down
2 changes: 1 addition & 1 deletion examples/meteorites/meteorites_cloud.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"metadata": {},
"outputs": [],
"source": [
"!pip install -U pandas-profiling"
"!pip install -U ydata-profiling"
]
},
{
Expand Down
3 changes: 2 additions & 1 deletion examples/titanic/titanic.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
"source": [
"import sys\n",
"\n",
"!\"{sys.executable}\" -m pip install -U pandas-profiling[notebook]\n",
"!\"{sys.executable}\" -m pip install -U ydata-profiling[notebook]\n",
"!pip install jupyter-contrib-nbextensions\n",
"!jupyter nbextension enable --py widgetsnbextension"
]
},
Expand Down
2 changes: 1 addition & 1 deletion examples/titanic/titanic_cloud.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"metadata": {},
"outputs": [],
"source": [
"!pip install -U pandas-profiling"
"!pip install -U ydata-profiling"
]
},
{
Expand Down
28 changes: 27 additions & 1 deletion examples/usaairquality/usaairquality.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
"import sys\n",
"\n",
"!{sys.executable} -m pip install -U pandas-profiling[notebook]\n",
"!pip install jupyter-contrib-nbextensions\n",
"!jupyter nbextension enable --py widgetsnbextension"
]
},
Expand Down Expand Up @@ -168,6 +169,31 @@
"\n",
" profile.to_file(f\"Ts_Profile_{group[0]}.html\")"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "7327cb70-3db8-441e-837e-4ac2a5a57eaa",
"metadata": {},
"outputs": [],
"source": [
"profile = ProfileReport(\n",
" group[1],\n",
" tsmode=True,\n",
" sortby=\"Date Local\",\n",
" # title=f\"Air Quality profiling - Site Num: {group[0]}\"\n",
")\n",
"\n",
"profile.to_file()"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "3c53d119-d014-4104-a5b2-76fd7a45181e",
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
Expand All @@ -186,7 +212,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.12"
"version": "3.11.9"
},
"varInspector": {
"cols": {
Expand Down
Loading