Test using StableRNGs (#55)

* switched tests to StableRNGs

* WIP need to instantiate a new StableRNG at fit()

* Made rng=StableRNG() in fit

* Bumped version and moved extras to test/

* updated travis-ci urls

* bump compat versions

* fix doc tests

* CI github action instead of travis

* limit GLMNet imports to avoid clash with GLM.coef

* don't test on julia 1.0 which doesn't support test/Project.toml

* updated badges

* increased rtol in CV tests

Author: AsafManela

.github/workflows/ci.yml

@@ -0,0 +1,65 @@
+name: CI
+on:
+  push:
+    branches: [master]
+    tags: ["*"]
+  pull_request:
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1' # automatically expands to the latest stable 1.x release of Julia
+          - 'nightly'
+        os:
+          - ubuntu-latest
+          - macOS-latest
+          - windows-latest
+        arch:
+          - x64
+          - x86
+        exclude:
+          - os: macOS-latest
+            arch: x86
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: actions/cache@v1
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v1
+        with:
+          file: lcov.info
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1'
+      - run: |
+          julia --project=docs -e '
+            using Pkg
+            Pkg.develop(PackageSpec(path=pwd()))
+            Pkg.instantiate()'
+      - run: julia --project=docs docs/make.jl
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.travis.yml

@@ -1,6 +1,6 @@
 name = "Lasso"
 uuid = "b4fcebef-c861-5a0f-a7e2-ba9dc32b180a"
-version = "0.5.2"
+version = "0.6.0"
 
 [deps]
 DSP = "717857b8-e6f2-59f4-9121-6e50c889abd2"
@@ -16,22 +16,10 @@ StatsModels = "3eaba693-59b7-5ba5-a881-562e759f1c8d"
 
 [compat]
 DSP = "0.6"
-Distributions = "0.23"
+Distributions = "0.24"
 GLM = "1.3"
 MLBase = "0.8"
 Reexport = "0.2"
-StatsBase = "0.32"
+StatsBase = "0.33"
 StatsModels = "0.6"
 julia = "0.7, 1"
-
-[extras]
-CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
-DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
-GLMNet = "8d5ece8b-de18-5317-b113-243142960cc6"
-LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
-Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
-SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
-
-[targets]
-test = ["CSV", "LinearAlgebra", "GLMNet", "DataFrames", "Random", "SparseArrays", "Test"]

Project.toml

@@ -2,19 +2,19 @@
 
 | **Documentation**                                                               | **Build Status**                                                                                |
 |:-------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|
-| [![][docs-stable-img]][docs-stable-url] [![][docs-dev-img]][docs-dev-url] | [![][travis-img]][travis-url] [![][codecov-img]][codecov-url] |
+| [![][docs-stable-img]][docs-stable-url] [![][docs-dev-img]][docs-dev-url] | [![][actions-img]][actions-url] [![][codecov-img]][codecov-url] |
 
 [docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
 [docs-dev-url]: https://juliastats.github.io/Lasso.jl/latest
 
 [docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
 [docs-stable-url]: https://juliastats.github.io/Lasso.jl/stable
 
-[travis-img]: https://travis-ci.org/JuliaStats/Lasso.jl.svg?branch=master
-[travis-url]: https://travis-ci.org/JuliaStats/Lasso.jl
+[actions-img]: https://github.com/JuliaStats/Lasso.jl/workflows/CI/badge.svg
+[actions-url]: https://github.com/JuliaStats/Lasso.jl/actions?query=workflow%3ACI+branch%3Amaster
 
-[codecov-img]: https://coveralls.io/repos/JuliaStats/Lasso.jl/badge.svg?branch=master
-[codecov-url]: https://coveralls.io/r/JuliaStats/Lasso.jl?branch=master
+[codecov-img]: http://codecov.io/github/JuliaStats/Lasso.jl/coverage.svg?branch=master
+[codecov-url]: http://codecov.io/github/JuliaStats/Lasso.jl?branch=master
 
 Lasso.jl is a pure Julia implementation of the glmnet coordinate
 descent algorithm for fitting linear and generalized linear Lasso and

README.md

@@ -34,12 +34,12 @@ julia> using DataFrames, Lasso
 
 julia> data = DataFrame(X=[1,2,3], Y=[2,4,7])
 3×2 DataFrames.DataFrame
-│ Row │ X     │ Y     │
-│     │ Int64 │ Int64 │
-├─────┼───────┼───────┤
-│ 1   │ 1     │ 2     │
-│ 2   │ 2     │ 4     │
-│ 3   │ 3     │ 7     │
+ Row │ X      Y
+     │ Int64  Int64
+─────┼──────────────
+   1 │     1      2
+   2 │     2      4
+   3 │     3      7
 ```
 
 Let's fit this to a model

docs/src/index.md

@@ -75,12 +75,12 @@ julia> Random.seed!(124); # because CV folds are random
 
 julia> data = DataFrame(X=[1,2,3], Y=[2,4,7])
 3×2 DataFrames.DataFrame
-│ Row │ X     │ Y     │
-│     │ Int64 │ Int64 │
-├─────┼───────┼───────┤
-│ 1   │ 1     │ 2     │
-│ 2   │ 2     │ 4     │
-│ 3   │ 3     │ 7     │
+ Row │ X      Y
+     │ Int64  Int64
+─────┼──────────────
+   1 │     1      2
+   2 │     2      4
+   3 │     3      7
 
 julia> m = fit(LassoModel, @formula(Y ~ X), data; select=MinCVmse(Kfold(3,2)))
 LassoModel using MinCVmse(Kfold([3, 1, 2], 2, 1.5)) segment of the regularization path.
@@ -95,7 +95,7 @@ x2   0.0
 
 julia> coef(m)
 2-element Array{Float64,1}:
- 4.333333333333335
+ 4.333333333333333
  0.0              
 
 ```

docs/src/lasso.md

@@ -124,14 +124,14 @@ end
 
 ## COEFFICIENT ITERATION IN SEQUENTIAL OR RANDOM ORDER
 struct RandomCoefficientIterator
-    rng::MersenneTwister
+    rng::AbstractRNG
     rg::Sampler
     coeforder::Vector{Int}
 end
 const RANDOMIZE_DEFAULT = true
 
-function RandomCoefficientIterator()
-    rng = MersenneTwister(1337)
+RandomCoefficientIterator(::Nothing) = RandomCoefficientIterator(MersenneTwister(1337))
+function RandomCoefficientIterator(rng)    
     RandomCoefficientIterator(rng, Sampler(rng, 1:2), Int[])
 end
 
@@ -425,6 +425,7 @@ fit(LassoPath, X, y, Binomial(), Logit();
 - `randomize=true`: Whether to randomize the order in which coefficients are
     updated by coordinate descent. This can drastically speed
     convergence if coefficients are highly correlated.
+- `rng=RNG_DEFAULT`: Random number generator to be used for coefficient iteration.
 - `maxncoef=min(size(X, 2), 2*size(X, 1))`: maximum number of coefficients
     allowed in the model. If exceeded, an error will be thrown.
 - `dofit=true`: Whether to fit the model upon construction. If `false`, the
@@ -463,6 +464,7 @@ function StatsBase.fit(::Type{LassoPath},
                        algorithm::Type=defaultalgorithm(d, l, size(X, 1), size(X, 2)),
                        dofit::Bool=true,
                        irls_tol::Real=1e-7, randomize::Bool=RANDOMIZE_DEFAULT,
+                       rng::Union{AbstractRNG, Nothing}=nothing,
                        maxncoef::Int=min(size(X, 2), 2*size(X, 1)),
                        penalty_factor::Union{Vector,Nothing}=nothing,
                        standardizeω::Bool=true,
@@ -477,7 +479,7 @@ function StatsBase.fit(::Type{LassoPath},
     α = convert(T, α)
     0 < α <= 1 || error("α must satisfy 0 < α <= 1")
     λminratio = convert(T, λminratio)
-    coefitr = randomize ? RandomCoefficientIterator() : (1:0)
+    coefitr = randomize ? RandomCoefficientIterator(rng) : (1:0)
 
     # penalty_factor (ω) defaults to a vector of ones
     ω = initpenaltyfactor(penalty_factor, size(X, 2), standardizeω)

src/Lasso.jl

@@ -65,6 +65,7 @@ function StatsBase.fit(::Type{GammaLassoPath},
                        algorithm::Type=defaultalgorithm(d, l, size(X, 1), size(X, 2)),
                        dofit::Bool=true,
                        irls_tol::Real=1e-7, randomize::Bool=RANDOMIZE_DEFAULT,
+                       rng::Union{AbstractRNG, Nothing}=nothing,
                        maxncoef::Int=min(size(X, 2), 2*size(X, 1)),
                        penalty_factor::Union{Vector,Nothing}=nothing,
                        standardizeω::Bool=true,
@@ -92,7 +93,7 @@ function StatsBase.fit(::Type{GammaLassoPath},
     # Lasso initialization
     α = convert(T, α)
     λminratio = convert(T, λminratio)
-    coefitr = randomize ? RandomCoefficientIterator() : (1:0)
+    coefitr = randomize ? RandomCoefficientIterator(rng) : (1:0)
     cd = algorithm{T,intercept,typeof(X),typeof(coefitr),typeof(ω)}(X, α, maxncoef, 1e-7, coefitr, ω)
 
     # GLM response initialization

src/gammalasso.jl

@@ -0,0 +1,12 @@
+[deps]
+CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
+Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
+GLM = "38e38edf-8417-5370-95a0-9cbb8c7f171a"
+GLMNet = "8d5ece8b-de18-5317-b113-243142960cc6"
+LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+MLBase = "f0e99cf1-93fa-52ec-9ecc-5026115318e0"
+Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
+StableRNGs = "860ef19b-820b-49d6-a774-d7a799459cd3"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

test/Project.toml

@@ -14,7 +14,7 @@ path = fit(LassoPath, X, y; offset=offset)
 
 coefsAICc = coef(path, MinAICc())
 segminAICc = minAICc(path)
-@test segminAICc == 71
+@test segminAICc == 72
 @test coefsAICc == β[:,segminAICc]
 
 coefsBIC = coef(path, MinBIC())
@@ -24,26 +24,26 @@ segminBIC = Lasso.minBIC(path)
 
 coefsAIC = coef(path, MinAIC())
 segminAIC = Lasso.minAIC(path)
-@test segminAIC == 71
+@test segminAIC == 72
 @test coefsAIC == β[:,segminAIC]
 
 Random.seed!(13)
 gen = Kfold(length(y),10)
-segCVmin = cross_validate_path(path,MinCVmse(gen))
+segCVmin = cross_validate_path(path, MinCVmse(gen))
 coefsCVmin = coef(path, MinCVmse(path))
-@test segCVmin == 71
+@test segCVmin == 72
 @test coefsCVmin == β[:,segCVmin]
 
 Random.seed!(13)
 gen = Kfold(length(y),10)
 segCVmin = cross_validate_path(path,X,y, MinCVmse(gen), offset=offset)
 coefsCVmin = coef(path, MinCVmse(path))
-@test segCVmin == 71
+@test segCVmin == 72
 @test coefsCVmin == β[:,segCVmin]
 
 Random.seed!(13)
 coefsCV1se = coef(path, MinCV1se(path, 20))
-Random.seed!(13)
+Random.seed!( 13)
 segCV1se = cross_validate_path(path,X,y, MinCV1se(path, 20),offset=offset)
 @test segCV1se == 42
 @test coefsCV1se == β[:,segCV1se]