build based on 19dabbc

previews/PR496/.documenter/.vitepress/config.mts

@@ -0,0 +1,134 @@
+import { defineConfig } from 'vitepress'
+import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs'
+import mathjax3 from "markdown-it-mathjax3";
+import footnote from "markdown-it-footnote";
+import { transformerMetaWordHighlight } from '@shikijs/transformers';
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+ base: '/',// TODO: replace this in makedocs!
+ title: 'Lux',
+ description: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+ lastUpdated: true,
+ cleanUrls: true,
+ outDir: '../final_site', // This is required for MarkdownVitepress to work correctly...
+ head: [['link', { rel: 'icon', href: 'REPLACE_ME_DOCUMENTER_VITEPRESS' }]],
+
+ markdown: {
+ math: true,
+ config(md) {
+ md.use(tabsMarkdownPlugin),
+ md.use(mathjax3),
+ md.use(footnote)
+ },
+ theme: {
+ light: "github-light",
+ dark: "github-dark"
+ },
+ codeTransformers: [transformerMetaWordHighlight(),],
+
+ },
+ themeConfig: {
+ outline: 'deep',
+ // https://vitepress.dev/reference/default-theme-config
+ logo: { src: '/logo.png', width: 24, height: 24},
+ search: {
+ provider: 'local',
+ options: {
+ detailedView: true
+ }
+ },
+ nav: [
+ { text: 'Home', link: '/' },
+ { text: 'Getting Started', link: '/introduction/index' },
+ { text: 'Ecosystem', link: '/ecosystem' },
+ { text: 'Tutorials', link: '/tutorials/index' },
+ { text: 'Manual', link: '/manual/interface' },
+ { text: 'API', link: '/api/Lux/layers' }
+ ],
+
+ sidebar: [
+{ text: 'Lux.jl', link: '/index' },
+{ text: 'Ecosystem', link: '/ecosystem' },
+{ text: 'Getting Started', collapsed: false, items: [
+{ text: 'Introduction', link: '/introduction/index' },
+{ text: 'Overview', link: '/introduction/overview' },
+{ text: 'Resources', link: '/introduction/resources' },
+{ text: 'Citation', link: '/introduction/citation' }]
+ },
+{ text: 'Tutorials', collapsed: false, items: [
+{ text: 'Overview', link: '/tutorials/index' },
+{ text: 'Beginner', collapsed: false, items: [
+{ text: 'Julia & Lux for the Uninitiated', link: '/tutorials/beginner/1_Basics' },
+{ text: 'Fitting a Polynomial using MLP', link: '/tutorials/beginner/2_PolynomialFitting' },
+{ text: 'Training a Simple LSTM', link: '/tutorials/beginner/3_SimpleRNN' },
+{ text: 'MNIST Classification with SimpleChains', link: '/tutorials/beginner/4_SimpleChains' }]
+ },
+{ text: 'Intermediate', collapsed: false, items: [
+{ text: 'MNIST Classification using Neural ODEs', link: '/tutorials/intermediate/1_NeuralODE' },
+{ text: 'Bayesian Neural Network', link: '/tutorials/intermediate/2_BayesianNN' },
+{ text: 'Training a HyperNetwork on MNIST and FashionMNIST', link: '/tutorials/intermediate/3_HyperNet' }]
+ },
+{ text: 'Advanced', collapsed: false, items: [
+{ text: 'Training a Neural ODE to Model Gravitational Waveforms', link: '/tutorials/advanced/1_GravitationalWaveForm' }]
+ }]
+ },
+{ text: 'Manual', collapsed: false, items: [
+{ text: 'Markdown.Link(Any["Lux Interface"], "@id lux-interface")', link: '/manual/interface' },
+{ text: 'Debugging Lux Models', link: '/manual/debugging' },
+{ text: 'Dispatching on Custom Input Types', link: '/manual/dispatch_custom_input' },
+{ text: 'Markdown.Link(Any["Freezing Model Parameters"], "@id freezing-model-parameters")', link: '/manual/freezing_model_parameters' },
+{ text: 'GPU Management', link: '/manual/gpu_management' },
+{ text: 'Markdown.Link(Any["Migrating from Flux to Lux"], "@id migrate-from-flux")', link: '/manual/migrate_from_flux' },
+{ text: 'Initializing Weights', link: '/manual/weight_initializers' }]
+ },
+{ text: 'API Reference', collapsed: false, items: [
+{ text: 'Lux', collapsed: false, items: [
+{ text: 'Built-In Layers', link: '/api/Lux/layers' },
+{ text: 'Utilities', link: '/api/Lux/utilities' },
+{ text: 'Experimental Features', link: '/api/Lux/contrib' },
+{ text: 'Switching between Deep Learning Frameworks', link: '/api/Lux/switching_frameworks' }]
+ },
+{ text: 'Accelerator Support', collapsed: false, items: [
+{ text: 'LuxAMDGPU', link: '/api/Accelerator_Support/LuxAMDGPU' },
+{ text: 'LuxCUDA', link: '/api/Accelerator_Support/LuxCUDA' },
+{ text: 'Markdown.Link(Any["LuxDeviceUtils"], "@id LuxDeviceUtils-API")', link: '/api/Accelerator_Support/LuxDeviceUtils' }]
+ },
+{ text: 'Building Blocks', collapsed: false, items: [
+{ text: 'LuxCore', link: '/api/Building_Blocks/LuxCore' },
+{ text: 'LuxLib', link: '/api/Building_Blocks/LuxLib' },
+{ text: 'Markdown.Link(Any["WeightInitializers"], "@id WeightInitializers-API")', link: '/api/Building_Blocks/WeightInitializers' }]
+ },
+{ text: 'Domain Specific Modeling', collapsed: false, items: [
+{ text: 'Boltz', link: '/api/Domain_Specific_Modeling/Boltz' }]
+ },
+{ text: 'Testing Functionality', collapsed: false, items: [
+{ text: 'LuxTestUtils', link: '/api/Testing_Functionality/LuxTestUtils' }]
+ }]
+ }
+]
+,
+ editLink: { pattern: "github.com/LuxDL/Lux.jl/edit/dev/docs/src/:path" },
+ socialLinks: [
+ { icon: 'github', link: 'https://github.com/LuxDL/Lux.jl' }
+ ],
+ footer: {
+ message: 'Made with <a href="https://documenter.juliadocs.org/stable/" target="_blank"><strong>Documenter.jl</strong></a>, <a href="https://vitepress.dev" target="_blank"><strong>VitePress</strong></a> and <a href="https://luxdl.github.io/DocumenterVitepress.jl/stable" target="_blank"><strong>DocumenterVitepress.jl</strong></a><br>Released under the MIT License. Powered by the <a href="https://www.julialang.org">Julia Programming Language</a>.<br>',
+ copyright: `© Copyright ${new Date().getUTCFullYear()} Avik Pal.`
+ },
+ head: [
+ [
+ "script",
+ { async: "", src: "https://www.googletagmanager.com/gtag/js?id=G-Q8GYTEVTZ2" },
+ ],
+ [
+ "script",
+ {},
+ `window.dataLayer = window.dataLayer || [];
+ function gtag(){dataLayer.push(arguments);}
+ gtag('js', new Date());
+ gtag('config', 'G-Q8GYTEVTZ2');`,
+ ],
+ ],
+ }
+})

previews/PR496/.documenter/.vitepress/theme/index.ts

@@ -0,0 +1,21 @@
+// .vitepress/theme/index.ts
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import AsideTrustees from '../../components/AsideTrustees.vue'
+
+import { enhanceAppWithTabs } from 'vitepress-plugin-tabs/client'
+import './style.css'
+
+export default {
+ extends: DefaultTheme,
+ Layout() {
+ return h(DefaultTheme.Layout, null, {
+ // 'home-hero-info-after': () => h(HomeTrustees),
+ 'aside-ads-before': () => h(AsideTrustees),
+ })
+ },
+ enhanceApp({ app, router, siteData }) {
+ enhanceAppWithTabs(app)
+ }
+} satisfies Theme

previews/PR496/.documenter/.vitepress/theme/style.css

@@ -0,0 +1,201 @@
+/* Customize default theme styling by overriding CSS variables:
+https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/* Layouts */
+
+/* 
+ :root {
+ --vp-layout-max-width: 1440px;
+} */
+
+.VPHero .clip {
+ white-space: pre;
+ max-width: 500px;
+}
+
+/* Fonts */
+
+@font-face {
+ font-family: JuliaMono-Regular;
+ src: url("https://cdn.jsdelivr.net/gh/cormullion/juliamono/webfonts/JuliaMono-Regular.woff2");
+}
+
+:root {
+ /* Typography */
+ --vp-font-family-base: "Barlow", "Inter var experimental", "Inter var",
+ -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu,
+ Cantarell, "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif;
+
+ /* Code Snippet font */
+ --vp-font-family-mono: JuliaMono-Regular, monospace;
+
+}
+
+.mono {
+ /* 
+ Disable contextual alternates (kind of like ligatures but different) in monospace, 
+ which turns `/>` to an up arrow and `|>` (the Julia pipe symbol) to an up arrow as well. 
+ This is pretty bad for Julia folks reading even though copy+paste retains the same text.
+ */
+ font-feature-settings: 'calt' 0;
+
+ pre {
+ font-family: JuliaMono-Light;
+ }
+
+ ;
+
+ code {
+ font-family: JuliaMono-Light;
+ }
+
+ ;
+}
+
+/* Colors */
+
+:root {
+ --julia-blue: #4063D8;
+ --julia-purple: #9558B2;
+ --julia-red: #CB3C33;
+ --julia-green: #389826;
+
+ --vp-c-brand: #389826;
+ --vp-c-brand-light: #3dd027;
+ --vp-c-brand-lighter: #9499ff;
+ --vp-c-brand-lightest: #bcc0ff;
+ --vp-c-brand-dark: #535bf2;
+ --vp-c-brand-darker: #454ce1;
+ --vp-c-brand-dimm: #212425;
+}
+
+/* Component: Button */
+
+:root {
+ --vp-button-brand-border: var(--vp-c-brand-light);
+ --vp-button-brand-text: var(--vp-c-white);
+ --vp-button-brand-bg: var(--vp-c-brand);
+ --vp-button-brand-hover-border: var(--vp-c-brand-light);
+ --vp-button-brand-hover-text: var(--vp-c-white);
+ --vp-button-brand-hover-bg: var(--vp-c-brand-light);
+ --vp-button-brand-active-border: var(--vp-c-brand-light);
+ --vp-button-brand-active-text: var(--vp-c-white);
+ --vp-button-brand-active-bg: var(--vp-button-brand-bg);
+}
+
+/* Component: Home */
+
+:root {
+ --vp-home-hero-name-color: transparent;
+ --vp-home-hero-name-background: -webkit-linear-gradient(120deg,
+ #9558B2 30%,
+ #CB3C33);
+
+ --vp-home-hero-image-background-image: linear-gradient(-45deg,
+ #9558B2 30%,
+ #389826 30%,
+ #CB3C33);
+ --vp-home-hero-image-filter: blur(40px);
+}
+
+@media (min-width: 640px) {
+ :root {
+ --vp-home-hero-image-filter: blur(56px);
+ }
+}
+
+@media (min-width: 960px) {
+ :root {
+ --vp-home-hero-image-filter: blur(72px);
+ }
+}
+
+/* Component: Custom Block */
+
+:root.dark {
+ --vp-custom-block-tip-border: var(--vp-c-brand);
+ --vp-custom-block-tip-text: var(--vp-c-brand-lightest);
+ --vp-custom-block-tip-bg: var(--vp-c-brand-dimm);
+
+ /* // Tweak the color palette for blacks and dark grays */
+ --vp-c-black: hsl(220 20% 9%);
+ --vp-c-black-pure: hsl(220, 24%, 4%);
+ --vp-c-black-soft: hsl(220 16% 13%);
+ --vp-c-black-mute: hsl(220 14% 17%);
+ --vp-c-gray: hsl(220 8% 56%);
+ --vp-c-gray-dark-1: hsl(220 10% 39%);
+ --vp-c-gray-dark-2: hsl(220 12% 28%);
+ --vp-c-gray-dark-3: hsl(220 12% 23%);
+ --vp-c-gray-dark-4: hsl(220 14% 17%);
+ --vp-c-gray-dark-5: hsl(220 16% 13%);
+
+ /* // Backgrounds */
+ /* --vp-c-bg: hsl(240, 2%, 11%); */
+ --vp-custom-block-info-bg: hsl(220 14% 17%);
+ /* --vp-c-gutter: hsl(220 20% 9%);
+ 
+ --vp-c-bg-alt: hsl(220 20% 9%);
+ --vp-c-bg-soft: hsl(220 14% 17%);
+ --vp-c-bg-mute: hsl(220 12% 23%);
+ */
+}
+
+/* Component: Algolia */
+
+.DocSearch {
+ --docsearch-primary-color: var(--vp-c-brand) !important;
+}
+
+/* Component: MathJax */
+
+mjx-container>svg {
+ display: block;
+ margin: auto;
+}
+
+mjx-container {
+ padding: 0.5rem 0;
+}
+
+mjx-container {
+ display: inline-block;
+ margin: auto 2px -2px;
+}
+
+mjx-container>svg {
+ margin: auto;
+ display: inline-block;
+}
+
+/**
+ * Colors links
+ * -------------------------------------------------------------------------- */
+
+:root {
+ --vp-c-brand-1: #CB3C33;
+ --vp-c-brand-2: #CB3C33;
+ --vp-c-brand-3: #CB3C33;
+ --vp-c-sponsor: #ca2971;
+ --vitest-c-sponsor-hover: #c13071;
+}
+
+.dark {
+ --vp-c-brand-1: #91dd33;
+ --vp-c-brand-2: #91dd33;
+ --vp-c-brand-3: #91dd33;
+ --vp-c-sponsor: #91dd33;
+ --vitest-c-sponsor-hover: #e51370;
+}
+
+/**
+ * Change images from light to dark theme
+ * -------------------------------------------------------------------------- */
+
+:root:not(.dark) .dark-only {
+ display: none;
+}
+
+:root:is(.dark) .light-only {
+ display: none;
+}

previews/PR496/.documenter/api/Accelerator_Support/LuxAMDGPU.md

@@ -0,0 +1,30 @@
+
+
+
+# LuxAMDGPU {#LuxAMDGPU}
+
+`LuxAMDGPU` is meant to be used as a trigger package for all `AMDGPU` dependencies in `Lux`. Users requiring AMDGPU support should install `LuxAMDGPU` and load it alongside `Lux`.
+
+## Index {#Index}
+- [`LuxAMDGPU.functional`](#LuxAMDGPU.functional-Tuple{})
+
+
+## API {#API}
+<div style='border-width:1px; border-style:solid; border-color:black; padding: 1em; border-radius: 25px;'>
+<a id='LuxAMDGPU.functional-Tuple{}' href='#LuxAMDGPU.functional-Tuple{}'>#</a>&nbsp;<b><u>LuxAMDGPU.functional</u></b> &mdash; <i>Method</i>.
+
+
+
+
+```julia
+functional()
+```
+
+
+Check if LuxAMDGPU is functional.
+
+
+[source](https://github.com/LuxDL/LuxAMDGPU.jl/blob/v0.2.2/src/LuxAMDGPU.jl#L24-L28)
+
+</div>
+<br>