Skip to content

Commit f6eec3f

Browse files
committed
docstring spelling fixes
1 parent 394f4bb commit f6eec3f

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

src/CIFAR10/interface.jl

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -209,11 +209,11 @@ function testlabels(args...; dir = nothing)
209209
end
210210

211211
"""
212-
traindata([T = N0f8], [indices]; [dir]) -> Tuple
212+
traindata([T = N0f8], [indices]; [dir]) -> images, labels
213213
214214
Returns the CIFAR-10 **trainingset** corresponding to the given
215215
`indices` as a two-element tuple. If `indices` is omitted the
216-
full trainingset is returned. The first element of three return
216+
full trainingset is returned. The first element of the return
217217
values will be the images as a multi-dimensional array, and the
218218
second element the corresponding labels as integers.
219219
@@ -314,11 +314,11 @@ function traindata(::Type{T}, indices::AbstractVector; dir = nothing) where T
314314
end
315315

316316
"""
317-
testdata([T = N0f8], [indices]; [dir]) -> Tuple
317+
testdata([T = N0f8], [indices]; [dir]) -> images, labels
318318
319319
Returns the CIFAR-10 **testset** corresponding to the given
320320
`indices` as a two-element tuple. If `indices` is omitted the
321-
full testset is returned. The first element of three return
321+
full testset is returned. The first element of the return
322322
values will be the images as a multi-dimensional array, and the
323323
second element the corresponding labels as integers.
324324
@@ -330,9 +330,9 @@ values of the labels correspond 1-to-1 the digit that they
330330
represent.
331331
332332
```julia
333-
train_x, train_y = CIFAR10.testdata() # full datatset
334-
train_x, train_y = CIFAR10.testdata(2) # only second observation
335-
train_x, train_y = CIFAR10.testdata(dir="./CIFAR10") # custom folder
333+
test_x, test_y = CIFAR10.testdata() # full datatset
334+
test_x, test_y = CIFAR10.testdata(2) # only second observation
335+
test_x, test_y = CIFAR10.testdata(dir="./CIFAR10") # custom folder
336336
```
337337
338338
$(download_docstring("CIFAR10", DEPNAME))

src/CIFAR100/interface.jl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -236,10 +236,10 @@ end
236236
237237
Returns the CIFAR-100 **trainset** corresponding to the given
238238
`indices` as a three-element tuple. If `indices` is omitted the
239-
full trainingset is returned. The first element of three return
240-
values (`X`) will be the images as a multi-dimensional array, the
241-
second element (`Yc`) the corresponding coarse labels as
242-
integers, and the third element (`Yf`) the fine labels
239+
full trainingset is returned. The first element of the three
240+
return values (`X`) will be the images as a multi-dimensional
241+
array, the second element (`Yc`) the corresponding coarse labels
242+
as integers, and the third element (`Yf`) the fine labels
243243
respectively.
244244
245245
The image(s) is/are returned in the native horizontal-major
@@ -317,7 +317,7 @@ end
317317
318318
Returns the CIFAR-100 **testset** corresponding to the given
319319
`indices` as a three-element tuple. If `indices` is omitted the
320-
full testset is returned. The first element of three return
320+
full testset is returned. The first element of the three return
321321
values (`X`) will be the images as a multi-dimensional array, the
322322
second element (`Yc`) the corresponding coarse labels as
323323
integers, and the third element (`Yf`) the fine labels

src/FashionMNIST/interface.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -217,11 +217,11 @@ function testlabels(index::Integer; dir = nothing)
217217
end
218218

219219
"""
220-
traindata([T = N0f8], [indices]; [dir]) -> Tuple
220+
traindata([T = N0f8], [indices]; [dir]) -> images, labels
221221
222222
Returns the Fashion-MNIST **trainingset** corresponding to the
223223
given `indices` as a two-element tuple. If `indices` is omitted
224-
the full trainingset is returned. The first element of three
224+
the full trainingset is returned. The first element of the
225225
return values will be the images as a multi-dimensional array,
226226
and the second element the corresponding labels as integers.
227227
@@ -251,11 +251,11 @@ end
251251
traindata(args...; dir = nothing) = traindata(N0f8, args...; dir = dir)
252252

253253
"""
254-
testdata([T = N0f8], [indices]; [dir]) -> Tuple
254+
testdata([T = N0f8], [indices]; [dir]) -> images, labels
255255
256256
Returns the Fashion-MNIST **testset** corresponding to the given
257257
`indices` as a two-element tuple. If `indices` is omitted the
258-
full testset is returned. The first element of three return values
258+
full testset is returned. The first element of the return values
259259
will be the images as a multi-dimensional array, and the second
260260
element the corresponding labels as integers.
261261

0 commit comments

Comments
 (0)