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

For a 1.0.1 release #51

Merged
merged 3 commits into from
Feb 19, 2025
Merged

For a 1.0.1 release #51

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
ec1a97f
Fix incorrect claim about FiniteIterable including RandomAccess
ablaom Feb 18, 2025
32335f4
bump 1.0.1
ablaom Feb 18, 2025
03a953b
Merge pull request #50 from JuliaAI/haslength-docfix
ablaom Feb 19, 2025
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
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "LearnAPI"
uuid = "92ad9a40-7767-427a-9ee6-6e577f1266cb"
authors = ["Anthony D. Blaom <[email protected]>"]
version = "1.0.0"
version = "1.0.1"

[compat]
julia = "1.10"
Expand Down
12 changes: 4 additions & 8 deletions src/types.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,14 +244,10 @@ struct RandomAccess <: Finite end
"""
LearnAPI.FiniteIterable

A data interface type. We say that `data` implements the `FiniteIterable` interface if
it implements Julia's `iterate` interface, including `Base.length`, and if
`Base.IteratorSize(typeof(data)) == Base.HasLength()`. For example, this is true if:

- `data` implements the [`LearnAPI.RandomAccess`](@ref) interface (arrays and most
tables); or

- `data isa MLCore.DataLoader`, which includes output from `MLCore.eachobs`.
A data interface type. We say that `data` implements the `FiniteIterable` interface if it
implements Julia's `iterate` interface, including `Base.length`, and if
`Base.IteratorSize(typeof(data)) == Base.HasLength()`. For example, this is true if `data
isa MLCore.DataLoader`, which includes the output of `MLUtils.eachobs`.

If [`LearnAPI.data_interface(learner)`](@ref) takes the value `FiniteIterable()`, then
[`obs`](@ref)`(learner, ...)` is guaranteed to return objects implementing the
Expand Down
Loading