Merge pull request #278 from FluxML/entity-tutorial

⭐️ Add entity embeddings workflow example
FluxML · Jan 20, 2025 · 178a52b · 178a52b
2 parents 111b308 + dbeaf9c
commit 178a52b
Show file tree

Hide file tree

Showing 9 changed files with 5,694 additions and 26 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,5 +1,6 @@
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
+CategoricalArrays = "324d7699-5711-5eae-9e2f-1d82baa6b597"
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
@@ -16,5 +17,9 @@ MLJXGBoostInterface = "54119dfa-1dab-4055-a167-80440f4f7a91"
 MLUtils = "f1d291b0-491e-4a28-83b9-f70985020b54"
 Optimisers = "3bd65402-5787-11e9-1adc-39752487f4e2"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
+ProgressMeter = "92933f4c-e287-5a05-a399-4b506db050ca"
 RDatasets = "ce6b1742-4840-55fa-b093-852dadbb1d8b"
+Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+ScientificTypes = "321657f4-b219-11e9-178b-2701a2544e81"
+Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
 WordTokenizers = "796a5d58-b03d-544a-977e-18100b691f6e"
diff --git a/docs/make.jl b/docs/make.jl
@@ -2,7 +2,7 @@ using Documenter
 using MLJFlux
 using Flux
 
-DocMeta.setdocmeta!(MLJFlux, :DocTestSetup, :(using MLJFlux); recursive=true)
+DocMeta.setdocmeta!(MLJFlux, :DocTestSetup, :(using MLJFlux); recursive = true)
 
 makedocs(
     sitename = "MLJFlux",
@@ -17,42 +17,36 @@ makedocs(
             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"
+        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",
+            "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",
+            "Incremental Training"=>"common_workflows/incremental_training/notebook.md",
+            "Entity Embeddings"=>"common_workflows/entity_embeddings/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",
+            "MNIST Images"=>"extended_examples/MNIST/notebook.md",
+            "Spam Detection with RNNs"=>"extended_examples/spam_detection/notebook.md",
         ],
         "Contributing" => "contributing.md"],
     doctest = false,