Skip to content

Commit 1e2c26f

Browse files
dirty-cat-cidirty-cat-ci
committed
Pushing the docs to 0.5/ for branch: 0.5.X, commit 3302b050ab61fac868ad8e290a56078281697c83
1 parent 80b6119 commit 1e2c26f

File tree

205 files changed

+106382
-103136
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

205 files changed

+106382
-103136
lines changed

‎0.5/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 5a3f57b7ff178594516f2ae5cb3091d5
3+
config: 01f1e2d63ae167fdda55304498d9f154
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎0.5/CHANGES.html‎

Lines changed: 155 additions & 102 deletions
Large diffs are not rendered by default.

‎0.5/CONTRIBUTING.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
4242
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
4343
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Vibur" />
44-
<link rel="stylesheet" type="text/css" href="_static/jupyterlite_sphinx.css?v=e3ca86de" />
44+
<link rel="stylesheet" type="text/css" href="_static/jupyterlite_sphinx.css?v=2c9f8f05" />
4545
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
4646
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
4747
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
@@ -54,17 +54,17 @@
5454
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
5555
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
5656

57-
<script src="_static/documentation_options.js?v=b9afe91b"></script>
57+
<script src="_static/documentation_options.js?v=8e576371"></script>
5858
<script src="_static/doctools.js?v=9bcbadda"></script>
5959
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
6060
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
6161
<script src="_static/copybutton.js?v=fd10adb8"></script>
62-
<script src="_static/jupyterlite_sphinx.js?v=d6bdf5f8"></script>
62+
<script src="_static/jupyterlite_sphinx.js?v=96e329c5"></script>
6363
<script>DOCUMENTATION_OPTIONS.pagename = 'CONTRIBUTING';</script>
6464
<script>
6565
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
6666
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/skrub-data/skrub/main/doc/version.json';
67-
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1';
67+
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.2';
6868
DOCUMENTATION_OPTIONS.show_version_warning_banner =
6969
true;
7070
</script>
@@ -75,7 +75,7 @@
7575
<link rel="prev" title="About" href="about.html" />
7676
<meta name="viewport" content="width=device-width, initial-scale=1"/>
7777
<meta name="docsearch:language" content="en"/>
78-
<meta name="docsearch:version" content="0.5.1" />
78+
<meta name="docsearch:version" content="0.5.2" />
7979
</head>
8080

8181

‎0.5/RELEASE_PROCESS.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
4242
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
4343
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Vibur" />
44-
<link rel="stylesheet" type="text/css" href="_static/jupyterlite_sphinx.css?v=e3ca86de" />
44+
<link rel="stylesheet" type="text/css" href="_static/jupyterlite_sphinx.css?v=2c9f8f05" />
4545
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
4646
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
4747
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
@@ -54,17 +54,17 @@
5454
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
5555
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
5656

57-
<script src="_static/documentation_options.js?v=b9afe91b"></script>
57+
<script src="_static/documentation_options.js?v=8e576371"></script>
5858
<script src="_static/doctools.js?v=9bcbadda"></script>
5959
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
6060
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
6161
<script src="_static/copybutton.js?v=fd10adb8"></script>
62-
<script src="_static/jupyterlite_sphinx.js?v=d6bdf5f8"></script>
62+
<script src="_static/jupyterlite_sphinx.js?v=96e329c5"></script>
6363
<script>DOCUMENTATION_OPTIONS.pagename = 'RELEASE_PROCESS';</script>
6464
<script>
6565
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
6666
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/skrub-data/skrub/main/doc/version.json';
67-
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1';
67+
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.2';
6868
DOCUMENTATION_OPTIONS.show_version_warning_banner =
6969
true;
7070
</script>
@@ -74,7 +74,7 @@
7474
<link rel="search" title="Search" href="search.html" />
7575
<meta name="viewport" content="width=device-width, initial-scale=1"/>
7676
<meta name="docsearch:language" content="en"/>
77-
<meta name="docsearch:version" content="0.5.1" />
77+
<meta name="docsearch:version" content="0.5.2" />
7878
</head>
7979

8080

‎0.5/_downloads/0489157882e9236e99043be54168dbb0/00_getting_started.ipynb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"cell_type": "markdown",
1212
"metadata": {},
1313
"source": [
14-
"## Downloading example datasets\n\nThe :obj:`~skrub.datasets` module allows us to download tabular datasets and\ndemonstrate ``skrub``'s features.\n\n"
14+
"## Downloading example datasets\n\nThe :obj:`~skrub.datasets` module allows us to download tabular datasets and\ndemonstrate ``skrub``'s features.\n\n<div class=\"alert alert-info\"><h4>Note</h4><p>You can control the directory where the datasets are stored by:\n - setting in your environment the ``SKRUB_DATA_DIRECTORY`` variable to an\n absolute directory path,\n - using the parameter ``data_directory`` in fetch functions, which takes\n precedence over the envar.\n\n By default, the datasets are stored in a folder named \"skrub_data\" in the\n user home folder.</p></div>\n\n"
1515
]
1616
},
1717
{
@@ -36,7 +36,7 @@
3636
"cell_type": "markdown",
3737
"metadata": {},
3838
"source": [
39-
"## Generating an interactive report for a dataframe\n\nTo quickly get an overview of a dataframe's contents, use the\n:class:`~skrub.TableReport`.\n\n"
39+
"## Generating an interactive report for a dataframe\n\nThe :class:`~skrub.SimpleCleaner` allows to clean the\ndataframe, parsing nulls, dates, and dropping columns with too many nulls.\nTo quickly get an overview of a dataframe's contents, use the\n:class:`~skrub.TableReport`.\n%%\n\n"
4040
]
4141
},
4242
{
@@ -47,7 +47,7 @@
4747
},
4848
"outputs": [],
4949
"source": [
50-
"from skrub import TableReport\n\nTableReport(employees_df)"
50+
"from skrub import SimpleCleaner, TableReport\n\nemployees_df = SimpleCleaner().fit_transform(employees_df)\nTableReport(employees_df)"
5151
]
5252
},
5353
{

‎0.5/_downloads/0522377a9c84c41a56e86408aa8f4548/01_encodings.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -329,8 +329,10 @@
329329
plt.barh(
330330
y=labels,
331331
width=avg_importances[top_indices],
332-
yerr=std_importances[top_indices],
332+
xerr=std_importances[top_indices],
333+
ecolor="k",
333334
color="b",
335+
alpha=0.5,
334336
)
335337
plt.yticks(fontsize=15)
336338
plt.title("Feature importances")

‎0.5/_downloads/1beb4a6828e42ba7f09ae925e26e794b/02_text_with_string_encoders.zip‎

0 Bytes
Binary file not shown.

‎0.5/_downloads/1edecd3a067d076f9dde43db0a6ad2ac/00_getting_started.zip‎

1.25 KB
Binary file not shown.

‎0.5/_downloads/28079b3b8fa6a36780f883fc70c5a85b/01_encodings.zip‎

66 Bytes
Binary file not shown.

‎0.5/_downloads/38ad1b2980d16d044d27e5fdddda1e7e/00_getting_started.py‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,18 @@
1616
#
1717
# The :obj:`~skrub.datasets` module allows us to download tabular datasets and
1818
# demonstrate ``skrub``'s features.
19+
#
20+
# .. note::
21+
#
22+
# You can control the directory where the datasets are stored by:
23+
# - setting in your environment the ``SKRUB_DATA_DIRECTORY`` variable to an
24+
# absolute directory path,
25+
# - using the parameter ``data_directory`` in fetch functions, which takes
26+
# precedence over the envar.
27+
#
28+
# By default, the datasets are stored in a folder named "skrub_data" in the
29+
# user home folder.
30+
1931

2032
# %%
2133
from skrub.datasets import fetch_employee_salaries
@@ -31,12 +43,14 @@
3143
# Generating an interactive report for a dataframe
3244
# -------------------------------------------------
3345
#
46+
# The :class:`~skrub.SimpleCleaner` allows to clean the
47+
# dataframe, parsing nulls, dates, and dropping columns with too many nulls.
3448
# To quickly get an overview of a dataframe's contents, use the
3549
# :class:`~skrub.TableReport`.
36-
3750
# %%
38-
from skrub import TableReport
51+
from skrub import SimpleCleaner, TableReport
3952

53+
employees_df = SimpleCleaner().fit_transform(employees_df)
4054
TableReport(employees_df)
4155

4256
# %%

0 commit comments

Comments
 (0)