Skip to content

Commit 03a953b

Browse files
authored
Merge pull request #50 from JuliaAI/haslength-docfix
Fix an incorrect claim in the `FiniteIterable` doc-string
2 parents 92ea74a + 32335f4 commit 03a953b

File tree

2 files changed

+5
-9
lines changed

2 files changed

+5
-9
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "LearnAPI"
22
uuid = "92ad9a40-7767-427a-9ee6-6e577f1266cb"
33
authors = ["Anthony D. Blaom <[email protected]>"]
4-
version = "1.0.0"
4+
version = "1.0.1"
55

66
[compat]
77
julia = "1.10"

src/types.jl

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -244,14 +244,10 @@ struct RandomAccess <: Finite end
244244
"""
245245
LearnAPI.FiniteIterable
246246
247-
A data interface type. We say that `data` implements the `FiniteIterable` interface if
248-
it implements Julia's `iterate` interface, including `Base.length`, and if
249-
`Base.IteratorSize(typeof(data)) == Base.HasLength()`. For example, this is true if:
250-
251-
- `data` implements the [`LearnAPI.RandomAccess`](@ref) interface (arrays and most
252-
tables); or
253-
254-
- `data isa MLCore.DataLoader`, which includes output from `MLCore.eachobs`.
247+
A data interface type. We say that `data` implements the `FiniteIterable` interface if it
248+
implements Julia's `iterate` interface, including `Base.length`, and if
249+
`Base.IteratorSize(typeof(data)) == Base.HasLength()`. For example, this is true if `data
250+
isa MLCore.DataLoader`, which includes the output of `MLUtils.eachobs`.
255251
256252
If [`LearnAPI.data_interface(learner)`](@ref) takes the value `FiniteIterable()`, then
257253
[`obs`](@ref)`(learner, ...)` is guaranteed to return objects implementing the

0 commit comments

Comments
 (0)