Skip to content

Commit

Permalink
build based on 8cc46c8
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 9, 2024
1 parent f7a0428 commit 19961af
Show file tree
Hide file tree
Showing 22 changed files with 79 additions and 56 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-09T09:52:19","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-09T13:38:38","documenter_version":"1.7.0"}}
15 changes: 7 additions & 8 deletions dev/_intro.qmd
View file
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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}
Expand All @@ -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()
Expand All @@ -77,7 +76,7 @@ The model can be wrapped in data and trained using the `fit!` function:

```{julia}
mach = machine(clf, X, y)
fit!(mach)
fit!(mach, verbosity=1)
```

The results are visualised below. The model has learned to discriminate between the two classes (as indicated by the contours) and to generate samples from each class (as indicated by the stars).
Expand Down
68 changes: 41 additions & 27 deletions dev/assets/documenter.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dev/assets/resources-commonmark/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Further Resources · JointEnergyModels.jl</title><meta name="title" content="Further Resources · JointEnergyModels.jl"/><meta property="og:title" content="Further Resources · JointEnergyModels.jl"/><meta property="twitter:title" content="Further Resources · JointEnergyModels.jl"/><meta name="description" content="Documentation for JointEnergyModels.jl."/><meta property="og:description" content="Documentation for JointEnergyModels.jl."/><meta property="twitter:description" content="Documentation for JointEnergyModels.jl."/><meta property="og:url" content="https://juliatrustworthyai.github.io/JointEnergyModels.jl/assets/resources-commonmark/"/><meta property="twitter:url" content="https://juliatrustworthyai.github.io/JointEnergyModels.jl/assets/resources-commonmark/"/><link rel="canonical" href="https://juliatrustworthyai.github.io/JointEnergyModels.jl/assets/resources-commonmark/"/><script data-outdated-warner src="../warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../logo.svg" alt="JointEnergyModels.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">JointEnergyModels.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">🏠 Home</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Further Resources</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Further Resources</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaTrustworthyAI/JointEnergyModels.jl/blob/main/docs/src/assets/resources-commonmark.md#" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Further-Resources"><a class="docs-heading-anchor" href="#Further-Resources">Further Resources</a><a id="Further-Resources-1"></a><a class="docs-heading-anchor-permalink" href="#Further-Resources" title="Permalink"></a></h1><h2 id="JuliaCon-2022"><a class="docs-heading-anchor" href="#JuliaCon-2022">JuliaCon 2022</a><a id="JuliaCon-2022-1"></a><a class="docs-heading-anchor-permalink" href="#JuliaCon-2022" title="Permalink"></a></h2><p>Slides: <a href="../juliacon22/presentation.html">link</a></p><h2 id="JuliaCon-Proceedings-Paper"><a class="docs-heading-anchor" href="#JuliaCon-Proceedings-Paper">JuliaCon Proceedings Paper</a><a id="JuliaCon-Proceedings-Paper-1"></a><a class="docs-heading-anchor-permalink" href="#JuliaCon-Proceedings-Paper" title="Permalink"></a></h2><p>TBD</p></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Monday 9 September 2024 09:52">Monday 9 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Further Resources · JointEnergyModels.jl</title><meta name="title" content="Further Resources · JointEnergyModels.jl"/><meta property="og:title" content="Further Resources · JointEnergyModels.jl"/><meta property="twitter:title" content="Further Resources · JointEnergyModels.jl"/><meta name="description" content="Documentation for JointEnergyModels.jl."/><meta property="og:description" content="Documentation for JointEnergyModels.jl."/><meta property="twitter:description" content="Documentation for JointEnergyModels.jl."/><meta property="og:url" content="https://juliatrustworthyai.github.io/JointEnergyModels.jl/assets/resources-commonmark/"/><meta property="twitter:url" content="https://juliatrustworthyai.github.io/JointEnergyModels.jl/assets/resources-commonmark/"/><link rel="canonical" href="https://juliatrustworthyai.github.io/JointEnergyModels.jl/assets/resources-commonmark/"/><script data-outdated-warner src="../warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../logo.svg" alt="JointEnergyModels.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">JointEnergyModels.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">🏠 Home</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Further Resources</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Further Resources</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaTrustworthyAI/JointEnergyModels.jl/blob/main/docs/src/assets/resources-commonmark.md#" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Further-Resources"><a class="docs-heading-anchor" href="#Further-Resources">Further Resources</a><a id="Further-Resources-1"></a><a class="docs-heading-anchor-permalink" href="#Further-Resources" title="Permalink"></a></h1><h2 id="JuliaCon-2022"><a class="docs-heading-anchor" href="#JuliaCon-2022">JuliaCon 2022</a><a id="JuliaCon-2022-1"></a><a class="docs-heading-anchor-permalink" href="#JuliaCon-2022" title="Permalink"></a></h2><p>Slides: <a href="../juliacon22/presentation.html">link</a></p><h2 id="JuliaCon-Proceedings-Paper"><a class="docs-heading-anchor" href="#JuliaCon-Proceedings-Paper">JuliaCon Proceedings Paper</a><a id="JuliaCon-Proceedings-Paper-1"></a><a class="docs-heading-anchor-permalink" href="#JuliaCon-Proceedings-Paper" title="Permalink"></a></h2><p>TBD</p></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 9 September 2024 13:38">Monday 9 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 19961af

Please sign in to comment.