Merge pull request #6 from JuliaAI/dev

Update README.md

Author: ablaom

.github/workflows/ci.yml

@@ -55,64 +55,14 @@ jobs:
       - uses: julia-actions/setup-julia@v1
         with:
           version: '1'
-      - run: |
-         julia -e '
-           function set_environment_variable(name::AbstractString, value::AbstractString)
-               github_env = ENV["GITHUB_ENV"]
-               touch(github_env)
-               open(github_env, "a") do io
-                   println(io, "$(name)=$(value)")
-               end
-           end
-           event_name = "${{ github.event_name }}"
-           if event_name == "pull_request"
-               base_ref = "${{ github.base_ref }}"
-               head_ref = "${{ github.head_ref }}"
-               base_repository = "${{ github.repository }}"
-               head_repository = "${{ github.event.pull_request.head.repo.full_name }}"
-               build_docs = (base_ref == "master") && (head_ref == "dev") && (base_repository == head_repository)
-           elseif event_name == "push"
-               ref = "${{ github.ref }}"
-               build_docs = (ref == "refs/heads/master") || (startswith(ref, "refs/tags/"))
-           elseif event_name == "schedule"
-               build_docs = ref == "refs/heads/master"
-           elseif event_name == "workflow_dispatch"
-               build_docs = ref == "refs/heads/master"
-           else
-               build_docs = false
-           end
-           if build_docs
-               @info("We will build the docs")
-               set_environment_variable("BUILD_DOCS", "true")
-           else 
-               @info("We will NOT build the docs")
-               set_environment_variable("BUILD_DOCS", "false")
-           end'
-      - run: |
-          julia --project=docs -e '
-            if ENV["BUILD_DOCS"] == "true"
-                using Pkg
-                Pkg.develop(PackageSpec(path=pwd()))
-                Pkg.instantiate()
-            end'
-      - run: |
-          julia --project=docs -e '
-            if ENV["BUILD_DOCS"] == "true"
-                using Documenter: doctest
-                using LearnAPI
-                @info "attempting to run the doctests"
-                doctest(LearnAPI)
-            else
-                @info "skipping the doctests"
-            end'
-      - run: julia --project=docs -e '
-            if ENV["BUILD_DOCS"] == "true"
-                @info "attempting to build the docs"
-                run(`julia --project=docs docs/make.jl`)
-                @info "successfully built the docs"
-            else
-                @info "skipping the docs build"
-            end'
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-docdeploy@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+      - run: |
+          julia --project=docs -e '
+            using Documenter: DocMeta, doctest
+            using LearnAPI
+            DocMeta.setdocmeta!(LearnAPI, :DocTestSetup, :(using LearnAPI); recursive=true)
+            doctest(LearnAPI)'

Project.toml

@@ -4,4 +4,12 @@ authors = ["Anthony D. Blaom <anthony.blaom@gmail.com>"]
 version = "0.1.0"
 
 [deps]
+InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
+
+[extras]
+SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[targets]
+test = ["SparseArrays", "Test"]

README.md

@@ -2,7 +2,7 @@
 
 A Julia interface for training and applying machine learning models.
 
-**Status:** Proposal.
+**Status:** Proposal. 
 
 
 🚧

docs/Project.toml

@@ -1,6 +1,8 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 LearnAPI = "92ad9a40-7767-427a-9ee6-6e577f1266cb"
+ScientificTypesBase = "30f210dd-8aff-4c5f-94ba-8e64358c1161"
+Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
 
 [compat]
 Documenter = "^0.27"

docs/make.jl

@@ -9,11 +9,11 @@ makedocs(;
     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",
+        "Common Implementation Patterns" => "common_implementation_patterns.md",
     ],
     repo="https://$REPO/blob/{commit}{path}#L{line}",
     sitename="LearnAPI.jl"

docs/src/accessor_functions

@@ -0,0 +1,15 @@
+# Accessor Functions 
+
+> **Summary.** While byproducts of training are ordinarily recorded in the `report`
+> component of the output of `fit`/`update!`/`ingest!`, some families of models report an
+> itme that is likely shared by multiple model types, and it is useful to have common
+> interface for accessing these directly. Training losses and feature importances are two
+> examples.
+
+```@docs
+LearnAPI.feature_importances
+LearnAPI.training_labels
+LearnAPI.training_losses
+LearnAPI.training_scores
+```
+