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: ClusterFoldValidation api #649

Merged
merged 3 commits into from
Apr 9, 2024
Merged

docs: ClusterFoldValidation api #649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
97b3227
add ClusterFoldValidation in the API page section
FBruzzesi Apr 8, 2024
f7ec1c4
bump version
FBruzzesi Apr 8, 2024
f35f75b
0.9.0 -> 0.8.2
FBruzzesi Apr 8, 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
10 changes: 7 additions & 3 deletions docs/api/model-selection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
# Model Selection

:::sklego.model_selection.GroupTimeSeriesSplit
:::sklego.model_selection.TimeGapSplit
options:
show_root_full_path: true
show_root_heading: true

:::sklego.model_selection.KlusterFoldValidation
:::sklego.model_selection.GroupTimeSeriesSplit
options:
show_root_full_path: true
show_root_heading: true

:::sklego.model_selection.TimeGapSplit
:::sklego.model_selection.ClusterFoldValidation
options:
show_root_full_path: true
show_root_heading: true

## `KlusterFoldValidation`

Prior to `version 0.8.2`, the `ClusterFoldValidation` class was named `KlusterFoldValidation`. The old name is deprecated and will be removed in a future releases.
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "scikit-lego"
version = "0.8.1"
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically ... we're not introducing breaking changes here, right? So we might also consider 0.8.2? Or am I missing something?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, let me change it in both places

version = "0.8.2"
description="A collection of lego bricks for scikit-learn pipelines"

license = {file = "LICENSE"}
Expand Down
2 changes: 1 addition & 1 deletion sklego/model_selection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ class ClusterFoldValidation:
"""Cross validator that creates folds based on provided cluster method.
This ensures that data points in the same cluster are not split across different folds.

!!! info "New in version 0.9.0"
!!! info "New in version 0.8.2"

Parameters
----------
Expand Down