Module statkit.model_selection

Expand source code
from deprecation import deprecated  # type: ignore
import statkit
from statkit.dataset import split_multinomial_dataset


@deprecated(
    deprecated_in="0.2.7",
    removed_in="0.3.0",
    current_version=statkit.__version__,
    details="Use `split_multinomial_dataset` instead.",
)
def holdout_split(X, test_size=0.5, random_state=None):
    """Make train-test split from of a dataset of multinomial draws.

    Args:
        X: A dataset of multinomial observations, with independent samples along the
            rows.
        test_size: Proportion of draws to reserve for the test set.
        random_state: Seed for numpy pseudo random number generator state.

    Returns:
        A pair `X_train`, `X_test` both with same shape as `X`.
    """
    return split_multinomial_dataset(X, test_size, random_state)

Functions

def holdout_split(X, test_size=0.5, random_state=None)

Make train-test split from of a dataset of multinomial draws.

Args

X
A dataset of multinomial observations, with independent samples along the rows.
test_size
Proportion of draws to reserve for the test set.
random_state
Seed for numpy pseudo random number generator state.

Returns

A pair X_train, X_test both with same shape as X.

Deprecated since version: 0.2.7

This will be removed in 0.3.0. Use split_multinomial_dataset instead.

Expand source code
@deprecated(
    deprecated_in="0.2.7",
    removed_in="0.3.0",
    current_version=statkit.__version__,
    details="Use `split_multinomial_dataset` instead.",
)
def holdout_split(X, test_size=0.5, random_state=None):
    """Make train-test split from of a dataset of multinomial draws.

    Args:
        X: A dataset of multinomial observations, with independent samples along the
            rows.
        test_size: Proportion of draws to reserve for the test set.
        random_state: Seed for numpy pseudo random number generator state.

    Returns:
        A pair `X_train`, `X_test` both with same shape as `X`.
    """
    return split_multinomial_dataset(X, test_size, random_state)