Skip to content

Commit 722c448

Browse files
authored
docs(website): generalize name to "Data splitting" (#128)
1 parent 6041907 commit 722c448

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

docs/_quarto.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ website:
8686

8787
- section: Utilities
8888
contents:
89-
- reference/utils-train-test-split.qmd
89+
- reference/utils-data-splitting.qmd
9090

9191
format:
9292
html:
@@ -204,7 +204,7 @@ quartodoc:
204204
path: steps-outlier-handling
205205
summary:
206206
name: Outlier handling
207-
desc: Handle outliers
207+
desc: Outlier detection and handling
208208
contents:
209209
- HandleUnivariateOutliers
210210

@@ -234,9 +234,9 @@ quartodoc:
234234
package: ibis_ml
235235
contents:
236236
- kind: page
237-
path: utils-train-test-split
237+
path: utils-data-splitting
238238
summary:
239-
name: Train-test split
240-
desc: Randomly split Ibis table
239+
name: Data splitting
240+
desc: Segregating data into training, testing, and validation sets
241241
contents:
242242
- train_test_split

ibis_ml/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
)
2929
from ibis_ml.steps import *
3030
from ibis_ml.utils._pprint import _pprint_recipe, _pprint_step, _safe_repr
31-
from ibis_ml.utils._train_test_split import train_test_split
31+
from ibis_ml.utils._split import train_test_split
3232

3333
# Add support for `Recipe`s and `Step`s to the built-in `PrettyPrinter`.
3434
pprint.PrettyPrinter._dispatch[Recipe.__repr__] = _pprint_recipe # noqa: SLF001

ibis_ml/utils/_train_test_split.py renamed to ibis_ml/utils/_split.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,11 @@ def train_test_split(
6262
6363
>>> table = ibis.memtable({"key1": range(100)})
6464
>>> train_table, test_table = ml.train_test_split(
65-
table,
66-
unique_key="key1",
67-
test_size=0.2,
68-
random_seed=0,
69-
)
65+
... table,
66+
... unique_key="key1",
67+
... test_size=0.2,
68+
... random_seed=0,
69+
... )
7070
"""
7171
if not (0 < test_size < 1):
7272
raise ValueError("test size should be a float between 0 and 1.")

0 commit comments

Comments
 (0)