Merge pull request #28 from CarloLucibello/update

add Project.toml and related updates

Author: Evizero

.travis.yml

@@ -3,8 +3,8 @@ os:
   - linux
   - osx
 julia:
-  - 0.7
   - 1.0
+  - 1.2
   - nightly
 notifications:
   email: false
@@ -19,21 +19,17 @@ addons:
   apt: # apt-get for linux
     packages:
       - hdf5-tools
-
+      
 jobs:
   include:
-    - stage: deploy
-      julia: 0.7
+    - stage: "Documentation"
+      julia: 1.0
       os: linux
       script:
-        - julia -e 'import Pkg; Pkg.clone(pwd()); Pkg.build("MLDatasets")'
-        - julia -e 'import Pkg; ps=Pkg.PackageSpec(name="Documenter", version="0.19"); Pkg.add(ps); Pkg.pin(ps)'
-        - julia -e 'import MLDatasets; ENV["DOCUMENTER_DEBUG"] = "true"; include(joinpath("docs","make.jl"))'
-
-## uncomment the following lines to override the default test script
-#script:
-#    - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
-#    - julia --check-bounds=yes --color=yes -e 'import Pkg; Pkg.clone(pwd()); Pkg.build("MLDatasets"); Pkg.test("MLDatasets"; coverage=true)';
+        - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
+                                    Pkg.instantiate()'
+        - julia --project=docs/ docs/make.jl
+      after_success: skip
 
 after_success:
-- julia -e 'using Pkg; Pkg.add("Coverage"); using Coverage; Coveralls.submit(process_folder())'
+- julia -e 'using Pkg; Pkg.add("Coverage"); using Coverage; Coveralls.submit(process_folder())'

Project.toml

@@ -0,0 +1,26 @@
+name = "MLDatasets"
+uuid = "eb30cadb-4394-5ae3-aed4-317e484a6458"
+version = "0.4.0"
+
+[deps]
+BinDeps = "9e28174c-4ba2-5203-b857-d8d62c4213ee"
+ColorTypes = "3da002f7-5984-5a60-b8a6-cbb66c0b333f"
+DataDeps = "124859b0-ceae-595e-8997-d05f6a7a8dfe"
+FixedPointNumbers = "53c48c17-4a7d-5ca2-90c5-79b7896eea93"
+GZip = "92fee26a-97fe-5a0c-ad85-20a5f3185b63"
+Requires = "ae029012-a4dd-5104-9daa-d747884805df"
+
+[compat]
+ColorTypes = "≥ 0.4.0"
+DataDeps = "≥ 0.3.0"
+FixedPointNumbers = "≥ 0.3.0"
+ImageCore = "≥ 0.1.2"
+julia = "≥ 1.0.0"
+
+[extras]
+ImageCore = "a09fc81d-aa75-5fe9-8630-4744c3626534"
+MAT = "23992714-dd62-5051-b70f-ba57cb901cac"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[targets]
+test = ["Test", "MAT", "ImageCore"]

README.md

@@ -8,10 +8,9 @@ accessing benchmark dataset. Functionality for the purpose of
 data processing or visualization is only provided to a degree
 that is special to some dataset._
 
-| **Package Status** | **Package Evaluator** | **Build Status**  |
-|:------------------:|:---------------------:|:-----------------:|
-| [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE.md) [![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaML.github.io/MLDatasets.jl/stable) | [![Julia 0.6 Status](http://pkg.julialang.org/badges/MLDatasets_0.6.svg)](http://pkg.julialang.org/?pkg=MLDatasets&ver=0.6) [![Julia 0.7 Status](http://pkg.julialang.org/badges/MLDatasets_0.7.svg)](http://pkg.julialang.org/?pkg=MLDatasets&ver=0.7) [![Julia 1.0 Status](http://pkg.julialang.org/badges/MLDatasets_1.0.svg)](http://pkg.julialang.org/?pkg=MLDatasets&ver=1.0) | [![Build Status](https://travis-ci.org/JuliaML/MLDatasets.jl.svg?branch=master)](https://travis-ci.org/JuliaML/MLDatasets.jl)|
-
+| **Package Status** | **Build Status**  |
+|:------------------:|:-----------------:|
+| [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE.md) [![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaML.github.io/MLDatasets.jl/stable) |  [![Build Status](https://travis-ci.org/JuliaML/MLDatasets.jl.svg?branch=master)](https://travis-ci.org/JuliaML/MLDatasets.jl)|
 
 This package is a part of the
 [`JuliaML`](https://github.com/JuliaML) ecosystem. Its

docs/Project.toml

@@ -0,0 +1,2 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

docs/make.jl

@@ -3,10 +3,10 @@ using Documenter, MLDatasets
 makedocs(
     modules = [MLDatasets],
     clean = false,
-    format = :html,
-    assets = [
-        joinpath("assets", "favicon.ico"),
-    ],
+    format = Documenter.HTML(
+                prettyurls = haskey(ENV, "CI"), 
+                assets = [joinpath("assets", "favicon.ico")]
+            ),
     sitename = "MLDatasets.jl",
     authors = "Hiroyuki Shindo, Christof Stocker",
     linkcheck = !("skiplinks" in ARGS),
@@ -23,14 +23,7 @@ makedocs(
         ],
         hide("Indices" => "indices.md"),
         "LICENSE.md",
-    ],
-    html_prettyurls = !("local" in ARGS),
+    ]
 )
 
-deploydocs(
-    repo = "github.com/JuliaML/MLDatasets.jl.git",
-    target = "build",
-    julia = "0.7",
-    deps = nothing,
-    make = nothing,
-)
+deploydocs(repo = "github.com/JuliaML/MLDatasets.jl.git")

docs/src/datasets/FashionMNIST.md

@@ -56,11 +56,11 @@ the Fashion-MNIST dataset in Julia more convenient.
 
 Function | Description
 ---------|-------------
-[`convert2features(array)`](@ref FashionMNIST.convert2features) | Convert the Fashion-MNIST tensor to a flat feature matrix
-[`convert2image(array)`](@ref FashionMNIST.convert2image) | Convert the Fashion-MNIST tensor/matrix to a colorant array
+[`convert2features(array)`](@ref MNIST.convert2features) | Convert the Fashion-MNIST tensor to a flat feature matrix
+[`convert2image(array)`](@ref MNIST.convert2image) | Convert the Fashion-MNIST tensor/matrix to a colorant array
 
 You can use the function
-[`convert2features`](@ref FashionMNIST.convert2features) to
+[`convert2features`](@ref MNIST.convert2features) to
 convert the given Fashion-MNIST tensor to a feature matrix (or
 feature vector in the case of a single image). The purpose of
 this function is to drop the spatial dimensions such that
@@ -73,7 +73,7 @@ julia> FashionMNIST.convert2features(FashionMNIST.traintensor()) # full training
 ```
 
 To visualize an image or a prediction we provide the function
-[`convert2image`](@ref FashionMNIST.convert2image) to convert the
+[`convert2image`](@ref MNIST.convert2image) to convert the
 given Fashion-MNIST horizontal-major tensor (or feature matrix)
 to a vertical-major `Colorant` array. The values are also color
 corrected according to the website's description, which means
@@ -109,14 +109,14 @@ FashionMNIST.testdata
 
 ### Utilities
 
-See [`MNIST.convert2features`](@ref) and
-[`MNIST.convert2image`](@ref)
-
 ```@docs
 FashionMNIST.download
 FashionMNIST.classnames
 ```
 
+Also, the `FashionMNIST` module is re-exporting [`convert2features`](@ref MNIST.convert2features)
+and [`convert2image`](@ref MNIST.convert2image) from the [`MNIST`](@ref) module.
+
 ## References
 
 - **Authors**: Han Xiao, Kashif Rasul, Roland Vollgraf

src/FashionMNIST/FashionMNIST.jl

@@ -20,13 +20,15 @@ replacement for MNIST.
 ## Utilities
 
 - [`FashionMNIST.download`](@ref)
-- [`MNIST.convert2features`](@ref)
-- [`MNIST.convert2image`](@ref)
+
+Also, the `FashionMNIST` module is re-exporting [`convert2features`](@ref MNIST.convert2features)
+and [`convert2image`](@ref MNIST.convert2image) from the [`MNIST`](@ref) module.
 """
 module FashionMNIST
     using DataDeps
     using FixedPointNumbers
     using ..MLDatasets: bytes_to_type, datafile, download_dep, download_docstring
+    import ..MNIST
     using ..MNIST: convert2image, convert2features
     using ..MNIST.Reader