Update documentation for breaking changes and improve usability of examples

.gitignore

@@ -1,4 +1,5 @@
 /Manifest.toml
+/docs/Manifest.toml
 .ipynb_checkpoints
 *~
 #*
@@ -7,4 +8,4 @@
 sandbox/
 docs/build
 /examples/mnist/mnist_machine*
-Manifest.toml
+*.jls

docs/Project.toml

@@ -1,6 +1,20 @@
 [deps]
+CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
 Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c"
+Imbalance = "c709b415-507b-45b7-9a3d-1767c89fde68"
+Languages = "8ef0a80b-9436-5d2c-a485-80b904378c43"
 MLDatasets = "eb30cadb-4394-5ae3-aed4-317e484a6458"
+MLJ = "add582a8-e3ab-11e8-2d5e-e98b27df1bc7"
+MLJDecisionTreeInterface = "c6f25543-311c-4c74-83dc-3ea6d1015661"
 MLJFlux = "094fc8d1-fd35-5302-93ea-dabda2abf845"
+MLJIteration = "614be32b-d00c-4edb-bd02-1eb411ab5e55"
+MLJMultivariateStatsInterface = "1b6a4a23-ba22-4f51-9698-8599985d3728"
+MLJXGBoostInterface = "54119dfa-1dab-4055-a167-80440f4f7a91"
+MLUtils = "f1d291b0-491e-4a28-83b9-f70985020b54"
+Optimisers = "3bd65402-5787-11e9-1adc-39752487f4e2"
+Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
+RDatasets = "ce6b1742-4840-55fa-b093-852dadbb1d8b"
+WordTokenizers = "796a5d58-b03d-544a-977e-18100b691f6e"

docs/make.jl

@@ -5,48 +5,57 @@ using Flux
 DocMeta.setdocmeta!(MLJFlux, :DocTestSetup, :(using MLJFlux); recursive=true)
 
 makedocs(
-	sitename = "MLJFlux",
-    format = Documenter.HTML(;
-    collapselevel = 1,
-    assets = [
-        "assets/favicon.ico",
-        asset(
-            "https://fonts.googleapis.com/css2?family=Lato:ital,wght@0,100;0,300;0,400;0,700;0,900;1,100;1,300;1,400;1,700;1,900&family=Montserrat:ital,wght@0,100..900;1,100..900&display=swap",
-            class = :css,
-        ),
-        asset(
-            "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/all.min.css",
-            class = :css,
-        )
-    ],
-    repolink="https://github.com/FluxML/MLJFlux.jl"
-),
-	modules = [MLJFlux],
-	warnonly = true,
-	pages = ["Introduction" => "index.md",
-            "Interface"=> Any[
-                "Summary"=>"interface/Summary.md",
-                "Builders"=>"interface/Builders.md",
-                "Custom Builders"=>"interface/Custom Builders.md",
-                "Classification"=>"interface/Classification.md",
-                "Regression"=>"interface/Regression.md",
-                "Multi-Target Regression"=>"interface/Multitarget Regression.md",
-                "Image Classification"=>"interface/Image Classification.md",
-            ],
-            "Workflow Examples" => Any[
-                "Incremental Training"=>"workflow examples/Incremental Training/incremental.md",
-                "Hyperparameter Tuning"=>"workflow examples/Hyperparameter Tuning/tuning.md",
-                "Neural Architecture Search"=>"workflow examples/Basic Neural Architecture Search/tuning.md",
-                "Model Composition"=>"workflow examples/Composition/composition.md",
-                "Model Comparison"=>"workflow examples/Comparison/comparison.md",
-                "Early Stopping"=>"workflow examples/Early Stopping/iteration.md",
-                "Live Training"=>"workflow examples/Live Training/live-training.md",
-            ],
-            # "Tutorials"=>Any[
-                # "Spam Detection with RNNs"=>"full tutorials/Spam Detection with RNNs/SMS.md"
-            # ],
-            "Contributing" => "contributing.md"],
-        doctest = false,
+    sitename = "MLJFlux",
+    format = Documenter.HTML(
+        collapselevel = 1,
+        assets = [
+            "assets/favicon.ico",
+            asset(
+                "https://fonts.googleapis.com/css2?family=Lato:ital,wght@0,100;0,300;0,400;0,700;0,900;1,100;1,300;1,400;1,700;1,900&family=Montserrat:ital,wght@0,100..900;1,100..900&display=swap",
+                class = :css,
+            ),
+            asset(
+                "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/all.min.css",
+                class = :css,
+            )
+        ],
+        repolink="https://github.com/FluxML/MLJFlux.jl"
+    ),
+    modules = [MLJFlux],
+    warnonly = true,
+    pages = [
+        "Introduction" => "index.md",
+        "Interface" => Any[
+            "Summary" => "interface/Summary.md",
+            "Builders" => "interface/Builders.md",
+            "Custom Builders" => "interface/Custom Builders.md",
+            "Classification" => "interface/Classification.md",
+            "Regression" => "interface/Regression.md",
+            "Multi-Target Regression" => "interface/Multitarget Regression.md",
+            "Image Classification" => "interface/Image Classification.md",
+        ],
+        "Common Workflows" => Any[
+            "Incremental Training" =>
+                "common_workflows/incremental_training/notebook.md",
+            "Hyperparameter Tuning" =>
+                "common_workflows/hyperparameter_tuning/notebook.md",
+            "Model Composition" =>
+                "common_workflows/composition/notebook.md",
+            "Model Comparison" =>
+                "common_workflows/comparison/notebook.md",
+            "Early Stopping" =>
+                "common_workflows/early_stopping/notebook.md",
+            "Live Training" =>
+                "common_workflows/live_training/notebook.md",
+            "Neural Architecture Search" =>
+                "common_workflows/architecture_search/notebook.md",
+        ],
+        "Extended Examples" => Any[
+            "MNIST Images" => "extended_examples/MNIST/notebook.md",
+            "Spam Detection with RNNs" => "extended_examples/spam_detection/notebook.md",
+        ],
+        "Contributing" => "contributing.md"],
+    doctest = false,
 )
 
 # Documenter can also automatically deploy documentation to gh-pages.