02. Getting Started
Basic API
split(data, strategy)
: main entry point.data
: array, tuple(X,)
or(X, y)
.strategy
: subtype ofSplitStrategy
.
Data Formats
- Accepts matrices, tables, or custom types implementing
sample_indices
.
Robust Index Handling
All splitting strategies in DataSplits are robust to arrays with arbitrary axes (e.g., OffsetArrays, SubArrays, etc.). The library automatically handles mapping between user-facing indices and internal positions, so you can use any AbstractArray as input.
Randomness Control
Pass rng
keyword to strategies supporting it, e.g. split(X, RandomSplit(0.7); rng=123)
.
Example: Custom Data Type
To use your own data type, implement sample_indices(data)
and get_sample(data, i)
.