Merge branch 'docs'

Author: tlienart

Project.toml

@@ -1,7 +1,7 @@
 name = "MLJLinearModels"
 uuid = "6ee0df7b-362f-4a72-a706-9e79364fb692"
 authors = ["Thibaut Lienart <[email protected]>"]
-version = "0.3.3"
+version = "0.3.4"
 
 [deps]
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"

README.md

@@ -4,7 +4,7 @@
 | :------------ | :------- | :------------ |
 | [![Build Status](https://travis-ci.org/alan-turing-institute/MLJLinearModels.jl.svg?branch=master)](https://travis-ci.org/alan-turing-institute/MLJLinearModels.jl) | [![codecov.io](http://codecov.io/github/alan-turing-institute/MLJLinearModels.jl/coverage.svg?branch=master)](http://codecov.io/github/alan-turing-institute/MLJLinearModels.jl?branch=master) | TODO |
 
-This is a convenience package gathering functionalities to solve a number of generalised linear regression/classification problems which, inherently, correspond to an optimisation problem of the form
+This is a package gathering functionalities to solve a number of generalised linear regression/classification problems which, inherently, correspond to an optimisation problem of the form
 
 ```
 L(y, Xθ) + P(θ)
@@ -20,8 +20,9 @@ The core aims of this package are:
 - focus on performance including in "big data" settings exploiting packages such as [`Optim.jl`](https://github.com/JuliaNLSolvers/Optim.jl), [`IterativeSolvers.jl`](https://github.com/JuliaMath/IterativeSolvers.jl),
 - use a "machine learning" perspective, i.e.: focus essentially on prediction, hyper-parameters should be obtained via a data-driven procedure such as cross-validation.
 
-All models allow to fit an intercept and allow the penalty to be applied or not on the intercept (not applied by default).
-All models attempt to be efficient in terms of memory allocation to avoid unnecessary copies of the data.
+# NOTES
+
+This section is only useful if you're interested in implementation details or would like to help extend the library. For usage instruction please head to the docs.
 
 ## Implemented
 

docs/build/assets/search.js

@@ -7401,6 +7401,7 @@ html.theme--documenter-dark {
     padding: 0;
     flex: 0 0 18rem;
     z-index: 5;
+    font-size: 15px;
     position: fixed;
     left: -18rem;
     width: 18rem;
@@ -7442,7 +7443,6 @@ html.theme--documenter-dark {
     html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu {
       flex-grow: 1;
       user-select: none;
-      font-size: 15px;
       border-top: 1px solid #5e6d6f;
       padding-bottom: 1.5rem;
       /* Managing collapsible submenus */ }
@@ -7482,16 +7482,21 @@ html.theme--documenter-dark {
         display: block;
         padding: 0.5rem 0.5rem; }
         html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu .tocitem, html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu .tocitem:hover {
-          color: #fff; }
+          color: #fff;
+          background: #282f2f; }
       html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu a.tocitem:hover, html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu label.tocitem:hover {
+        color: #fff;
         background-color: #32393a; }
       html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu li.is-active {
-        border-top: 1px solid #718385;
+        border-top: 1px solid #5e6d6f;
         border-bottom: 1px solid #5e6d6f;
         background-color: #1f2424; }
-        html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu li.is-active > .tocitem, html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu li.is-active > .tocitem:hover {
+        html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu li.is-active .tocitem, html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu li.is-active .tocitem:hover {
           background-color: #1f2424;
           color: #fff; }
+        html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu li.is-active ul.internal .tocitem:hover {
+          background-color: #32393a;
+          color: #fff; }
       html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu > li.is-active:first-child {
         border-top: none; }
       html.theme--documenter-dark #documenter .docs-sidebar ul.docs-menu ul.internal {

docs/build/assets/themes/documenter-dark.css

@@ -7383,6 +7383,7 @@ html {
   padding: 0;
   flex: 0 0 18rem;
   z-index: 5;
+  font-size: 1rem;
   position: fixed;
   left: -18rem;
   width: 18rem;
@@ -7424,7 +7425,6 @@ html {
   #documenter .docs-sidebar ul.docs-menu {
     flex-grow: 1;
     user-select: none;
-    font-size: 1rem;
     border-top: 1px solid #dbdbdb;
     padding-bottom: 1.5rem;
     /* Managing collapsible submenus */ }
@@ -7464,16 +7464,21 @@ html {
       display: block;
       padding: 0.5rem 0.5rem; }
       #documenter .docs-sidebar ul.docs-menu .tocitem, #documenter .docs-sidebar ul.docs-menu .tocitem:hover {
-        color: #0a0a0a; }
+        color: #0a0a0a;
+        background: whitesmoke; }
     #documenter .docs-sidebar ul.docs-menu a.tocitem:hover, #documenter .docs-sidebar ul.docs-menu label.tocitem:hover {
+      color: #0a0a0a;
       background-color: #ebebeb; }
     #documenter .docs-sidebar ul.docs-menu li.is-active {
-      border-top: 1px solid #c7c7c7;
+      border-top: 1px solid #dbdbdb;
       border-bottom: 1px solid #dbdbdb;
       background-color: white; }
-      #documenter .docs-sidebar ul.docs-menu li.is-active > .tocitem, #documenter .docs-sidebar ul.docs-menu li.is-active > .tocitem:hover {
+      #documenter .docs-sidebar ul.docs-menu li.is-active .tocitem, #documenter .docs-sidebar ul.docs-menu li.is-active .tocitem:hover {
         background-color: white;
         color: #0a0a0a; }
+      #documenter .docs-sidebar ul.docs-menu li.is-active ul.internal .tocitem:hover {
+        background-color: #ebebeb;
+        color: #0a0a0a; }
     #documenter .docs-sidebar ul.docs-menu > li.is-active:first-child {
       border-top: none; }
     #documenter .docs-sidebar ul.docs-menu ul.internal {