Merge pull request #2 from JuliaAI/dev

More docs

.github/workflows/ci.yml

@@ -99,9 +99,9 @@ jobs:
           julia --project=docs -e '
             if ENV["BUILD_DOCS"] == "true"
                 using Documenter: doctest
-                using MLInterface
+                using LearnAPI
                 @info "attempting to run the doctests"
-                doctest(MLInterface)
+                doctest(LearnAPI)
             else
                 @info "skipping the doctests"
             end'

Project.toml

@@ -1,4 +1,7 @@
-name = "MLInterface"
+name = "LearnAPI"
 uuid = "92ad9a40-7767-427a-9ee6-6e577f1266cb"
 authors = ["Anthony D. Blaom <anthony.blaom@gmail.com>"]
 version = "0.1.0"
+
+[deps]
+Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"

README.md

@@ -1,27 +1,16 @@
-# MLInterface.jl
+# LearnAPI.jl
 
-A Julia interface for training and applying models in machine learning and statistics
+A Julia interface for training and applying machine learning models.
 
 
 🚧
 
-Hyperlinks in this README.md do not work.
 
-| Linux | Coverage |
-| :------------ | :------- |
-| [![Build Status](https://github.com/JuliaAI/MLInterface.jl/workflows/CI/badge.svg)](https://github.com/JuliaAI/MLInterface.jl/actions) | [![Coverage](https://codecov.io/gh/JuliaAI/MLInterface.jl/branch/master/graph/badge.svg)](https://codecov.io/github/JuliaAI/MLInterface.jl?branch=master) |
+[![Build Status](https://github.com/JuliaAI/LearnAPI.jl/workflows/CI/badge.svg)](https://github.com/JuliaAI/LearnAPI.jl/actions)  
+[![Coverage](https://codecov.io/gh/JuliaAI/LearnAPI.jl/branch/master/graph/badge.svg)](https://codecov.io/github/JuliaAI/LearnAPI.jl?branch=master) 
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaai.github.io/LearnAPI.jl/stable/)
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaai.github.io/MLInterface.jl/stable/)
-
-
-**Status.** Proposal, unregistered. 
-
-This repository is to provide a general purpose machine learning interface. It is designed
-based on experiences of developers of MLJ's [MLJModelInterface.jl]() which it will
-eventually replace, but hopes to be useful more generally. The design is not yet fixed and
-comments (posted as issues) are welcome.
-
-To get an idea of the kinds of models we are aiming to indclude, see [Common Implementation
-Patterns]().
+Please refer to the documentation for a detailed preview of what this package proposes to
+offer.
 
 

docs/Project.toml

@@ -1,6 +1,6 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-MLInterface = "92ad9a40-7767-427a-9ee6-6e577f1266cb"
+LearnAPI = "92ad9a40-7767-427a-9ee6-6e577f1266cb"
 
 [compat]
 Documenter = "^0.27"

docs/make.jl

@@ -1,25 +1,26 @@
 using Documenter
-using MLInterface
+using LearnAPI
 
-const REPO="github.com/JuliaAI/MLInterface.jl"
+const REPO="github.com/JuliaAI/LearnAPI.jl"
 
 makedocs(;
-    modules=[MLInterface],
+    modules=[LearnAPI,],
     format=Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
     pages=[
         "Introduction" => "index.md",
         "Anatomy of an Implementation" => "anatomy_of_an_implementation.md",
         "Common Implementation Patterns" => "common_implementation_patterns.md",
         "Reference" => "reference.md",
         "Fit, update and ingest" => "fit_update_and_ingest.md",
+        "Predict and other operations" => "operations.md",
+        "Model Traits" => "model_traits.md",
     ],
     repo="https://$REPO/blob/{commit}{path}#L{line}",
-    sitename="MLInterface.jl"
+    sitename="LearnAPI.jl"
 )
 
-deploydocs(;
-    repo=REPO,
+deploydocs(
+    ; repo=REPO,
     devbranch="dev",
-    push_preview=false,
-
-           )
+    push_preview=true,
+)

docs/src/accessor_functions

@@ -0,0 +1,4 @@
+training_labels
+training_losses
+training_scores
+feature_importances