uf

Project.toml

@@ -1,7 +1,7 @@
 name = "JointEnergyModels"
 uuid = "48c56d24-211d-4463-bbc0-7a701b291131"
 authors = ["Patrick Altmeyer"]
-version = "0.1.6"
+version = "0.1.7"
 
 [deps]
 CategoricalArrays = "324d7699-5711-5eae-9e2f-1d82baa6b597"

README.qmd

@@ -9,12 +9,14 @@ crossref:
   tbl-prefix: Table
 bibliography: bib.bib
 output: asis
-jupyter: julia-1.10
 execute: 
   freeze: auto
-  eval: true
+  eval: false
   echo: true
   output: false
+engine: julia
+julia: 
+  exeflags: ["--project=docs/"]
 ---
 
 # `JointEnergyModels.jl`

docs/src/_intro.qmd

@@ -1,8 +1,3 @@
----
-execute: 
-  eval: false
----
-
 *Joint Energy Models in Julia.*
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliatrustworthyai.github.io/JointEnergyModels.jl/stable)
@@ -36,6 +31,11 @@ Pkg.add(url="https://github.com/juliatrustworthyai/JointEnergyModels.jl")
 
 ## 🔍 Usage Example
 
+```{=commonmark}
+!!! warning "Breaking Changes Anticipated"
+    To facilitate the interface to MLJFlux, this package currently overloads private methods. We are still deliberating 
+```
+
 Below we first generate some synthetic data:
 
 ```{julia}
@@ -47,10 +47,9 @@ Xplot = Float32.(permutedims(matrix(X)))
 X = table(permutedims(Xplot))
 plt = scatter(Xplot[1,:], Xplot[2,:], group=y, label="")
 batch_size = Int(round(nobs/10))
-display(plt)
 ```
 
-The `MLJ` compatible classifier can be instantiated as follows:
+The `MLJFlux` compatible classifier can be instantiated as follows:
 
 ```{julia}
 𝒟x = Normal()

docs/src/index.qmd

@@ -1,3 +1,9 @@
+---
+engine: julia
+julia: 
+  exeflags: ["--project=../"]
+---
+
 ```@meta
 CurrentModule = JointEnergyModels
 ```