Skip to content

Make default for v consistent between vfold_cv() and group_vfold_cv() #328

Open
@juliasilge

Description

@juliasilge

There is a lot of nice consistency between the new grouped variants implemented in #313, #315, and #316, but the original, older grouped resampling function group_vfold_cv() doesn't have the same default as its sister function vfold_cv(). With the default of v = NULL, it currently returns what is also called "leave-group-out" CV.

As @mattwarkentin correctly points out in #324:

Over time this may be confusing as users may grow to expect the group_* version of something to return a sampling pattern similar to the default for its non-grouped sibling.

Unfortunately, making these defaults consistent would be a breaking change, and also unfortunately it's the kind of breaking change we don't have good options for to communicate with users about. On the other hand, we know that group_vfold_cv() isn't a heavily used function in rsample.

🎯 What is the best option to pursue in this situation?

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions