Merge pull request #23 from alyst/opt_deps

Make ImageCore and MAT packages optional

Author: Evizero

.travis.yml

@@ -30,4 +30,4 @@ install:
 
 after_success:
   - julia -e 'using Pkg, MLDatasets; cd(joinpath(dirname(pathof(MLDatasets)), "..")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())';
-  - julie -e 'using Pkg; Pkg.add("Documenter"); cd(joinpath(dirname(pathof(MLDatasets)), "..")); include(joinpath("docs", "make.jl"))'
+  - julia -e 'using Pkg, MLDatasets; Pkg.add("Documenter"); cd(joinpath(dirname(pathof(MLDatasets)), "..")); include(joinpath("docs", "make.jl"))'

REQUIRE

@@ -1,8 +1,7 @@
 julia 0.7
-ImageCore 0.1.2
+Requires
 FixedPointNumbers 0.3
 ColorTypes 0.4
 DataDeps 0.3
-GZip
+GZip 0.5
 BinDeps
-MAT

docs/make.jl

@@ -30,7 +30,7 @@ makedocs(
 deploydocs(
     repo = "github.com/JuliaML/MLDatasets.jl.git",
     target = "build",
-    julia = "0.6",
+    julia = "0.7",
     deps = nothing,
     make = nothing,
 )

docs/src/LICENSE.md

@@ -1,5 +1,6 @@
 # LICENSE
 
 ```@eval
-Markdown.parse_file(joinpath(@__DIR__, "../LICENSE"))
+using Markdown
+Markdown.parse_file(joinpath(@__DIR__, "..", "..", "LICENSE"))
 ```

src/CIFAR10/CIFAR10.jl

@@ -2,10 +2,10 @@ export CIFAR10
 module CIFAR10
     using DataDeps
     using BinDeps
-    using ImageCore
     using ColorTypes
     using FixedPointNumbers
-    using ..MLDatasets: bytes_to_type, datafile, download_dep, download_docstring
+    using ..MLDatasets: bytes_to_type, datafile, download_dep, download_docstring,
+                        _colorview, _channelview
 
     export
 

src/CIFAR10/utils.jl

@@ -29,10 +29,10 @@ function convert2features(array::AbstractArray{<:Number,4})
 end
 
 convert2features(array::AbstractArray{<:RGB,2}) =
-    convert2features(permutedims(channelview(array), (3,2,1)))
+    convert2features(permutedims(_channelview(array), (3,2,1)))
 
 convert2features(array::AbstractArray{<:RGB,3}) =
-    convert2features(permutedims(channelview(array), (3,2,1,4)))
+    convert2features(permutedims(_channelview(array), (3,2,1,4)))
 
 """
     convert2image(array) -> Array{RGB}
@@ -68,13 +68,13 @@ end
 function convert2image(array::AbstractArray{<:Number,3})
     nrows, ncols, nchan = size(array)
     @assert nchan == 3 "the given array should have the RGB channel in the third dimension"
-    colorview(RGB, permutedims(_norm_array(array), (3,2,1)))
+    _colorview(RGB, permutedims(_norm_array(array), (3,2,1)))
 end
 
 function convert2image(array::AbstractArray{<:Number,4})
     nrows, ncols, nchan, nimages = size(array)
     @assert nchan == 3 "the given array should have the RGB channel in the third dimension"
-    colorview(RGB, permutedims(_norm_array(array), (3,2,1,4)))
+    _colorview(RGB, permutedims(_norm_array(array), (3,2,1,4)))
 end
 
 _norm_array(array::AbstractArray) = array

src/CIFAR100/CIFAR100.jl

@@ -4,7 +4,7 @@ module CIFAR100
     using BinDeps
     using FixedPointNumbers
     using ..MLDatasets: bytes_to_type, datafile, download_dep, download_docstring
-    import ..CIFAR10: convert2image, convert2features
+    using ..CIFAR10: convert2image, convert2features
 
     export
 

src/FashionMNIST/FashionMNIST.jl

@@ -27,8 +27,8 @@ module FashionMNIST
     using DataDeps
     using FixedPointNumbers
     using ..MLDatasets: bytes_to_type, datafile, download_dep, download_docstring
-    import ..MNIST: convert2image, convert2features
-    import ..MNIST.Reader
+    using ..MNIST: convert2image, convert2features
+    using ..MNIST.Reader
 
     export
 

src/MLDatasets.jl

@@ -1,13 +1,42 @@
 module MLDatasets
 
-using FixedPointNumbers
+using Requires
+using FixedPointNumbers, ColorTypes
 
 bytes_to_type(::Type{UInt8}, A::Array{UInt8}) = A
 bytes_to_type(::Type{N0f8}, A::Array{UInt8}) = reinterpret(N0f8, A)
 bytes_to_type(::Type{T}, A::Array{UInt8}) where T<:Integer = convert(Array{T}, A)
 bytes_to_type(::Type{T}, A::Array{UInt8}) where T<:AbstractFloat = A ./ T(255)
 bytes_to_type(::Type{T}, A::Array{UInt8}) where T<:Number  = convert(Array{T}, reinterpret(N0f8, A))
 
+global __images_supported__ = false
+global __matfiles_supported__ = false
+
+function _channelview(image::AbstractArray{<:Color})
+    __images_supported__ ||
+        error("Converting to/from image requires ImageCore package.")
+    channelview(image)
+end
+
+function _colorview(::Type{T}, array::AbstractArray{<:Number}) where T <: Color
+    __images_supported__ ||
+        error("Converting to image requires ImageCore package.")
+    colorview(T, array)
+end
+
+function _matopen(f::Function, path::AbstractString)
+    __matfiles_supported__ ||
+        error("Reading .mat files requires MAT package.")
+    matopen(f, path)
+end
+
+function _matread(path::AbstractString)
+    __matfiles_supported__ ||
+        error("Reading .mat files requires MAT package.")
+    matread(path)
+end
+
+
 include("download.jl")
 include("CoNLL.jl")
 
@@ -19,4 +48,16 @@ include("SVHN2/SVHN2.jl")
 include("PTBLM/PTBLM.jl")
 include("UD_English/UD_English.jl")
 
+function __init__()
+    # initialize optional dependencies
+    @require ImageCore="a09fc81d-aa75-5fe9-8630-4744c3626534" begin
+        using ImageCore
+        global __images_supported__ = true
+    end
+    @require MAT="23992714-dd62-5051-b70f-ba57cb901cac" begin
+        using MAT
+        global __matfiles_supported__ = true
+    end
+end
+
 end

src/MNIST/MNIST.jl

@@ -25,10 +25,10 @@ the 10 possible digits (0-9).
 """
 module MNIST
     using DataDeps
-    using ImageCore
     using ColorTypes
     using FixedPointNumbers
-    using ..MLDatasets: bytes_to_type, datafile, download_dep, download_docstring
+    using ..MLDatasets: bytes_to_type, datafile, download_dep, download_docstring,
+                        _colorview
 
     export