Skip to content

Unify markdown list in splitobs docstring #208

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Unify markdown list in splitobs docstring #208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions src/splitobs.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ The argument `at` specifies how to split the data:
- When `at` is a number between 0 and 1, this specifies the proportion in the first subset.
- When `at` is an integer, it specifies the number of observations in the first subset.
- When `at` is a tuple, entries specifies the number or proportion in each subset, except
for the last which will contain the remaning observations.
The number of returned subsets is `length(at)+1`.
for the last which will contain the remaning observations.
The number of returned subsets is `length(at)+1`.

If `shuffle=true`, randomly permute the observations before splitting.
A random number generator `rng` can be optionally passed as the first argument.
Expand Down Expand Up @@ -112,4 +112,4 @@ end

_normalize_at(n, at::Integer) = at / n
_normalize_at(n, at::NTuple{N, <:Integer}) where N = at ./ n
_normalize_at(n, at) = at
_normalize_at(n, at) = at
Loading