Skip to content

Commit

Permalink
Merge pull request #571 from LuxDL/ap/stable_docs
Browse files Browse the repository at this point in the history 
Try fixing the hydration error
  • Loading branch information
@avik-pal
avik-pal authored Apr 5, 2024
2 parents b7a0b63 + 1562870 commit 849ec40
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 29 deletions.
5 changes: 5 additions & 0 deletions .buildkite/pipeline.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,10 @@ steps:
npm i
cd ..
echo $BUILDKITE
echo $BUILDKITE_PULL_REQUEST
echo $BUILDKITE_TAG
julia --project --code-coverage=user --color=yes --threads=auto --project=docs -e '
println("--- :julia: Instantiating project")
using Pkg
Expand All @@ -205,6 +209,7 @@ steps:
env:
DATADEPS_ALWAYS_ACCEPT: true
JULIA_DEBUG: "Documenter"
DEBUG: true
GKSwstype: "100" # https://discourse.julialang.org/t/generation-of-documentation-fails-qt-qpa-xcb-could-not-connect-to-display/60988
if: build.message !~ /\[skip docs\]/ && !build.pull_request.draft
timeout_in_minutes: 240
Expand Down
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "Lux"
uuid = "b2108857-7c20-44ae-9111-449ecde12c47"
authors = ["Avik Pal <avikpal@mit.edu> and contributors"]
version = "0.5.31"
version = "0.5.32"

[deps]
ADTypes = "47edcb42-4c32-4615-8424-f2b9edc5f35b"
Expand Down
3 changes: 0 additions & 3 deletions docs/Project.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,3 @@ Optimisers = "3bd65402-5787-11e9-1adc-39752487f4e2"
Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
WeightInitializers = "d49dbf32-c5c2-4618-8acc-27bb2598ef2d"
Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"

[compat]
DocumenterVitepress = "0.0.13"
4 changes: 2 additions & 2 deletions docs/package.json
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"devDependencies": {
"markdown-it": "^14.0.0",
"markdown-it": "^14.1.0",
"markdown-it-mathjax3": "^4.3.2",
"vitepress": "^1.0.0-rc.43",
"vitepress": "^1.0.2",
"vitepress-plugin-tabs": "^0.5.0",
"vitest": "^1.3.0"
},
Expand Down
41 changes: 22 additions & 19 deletions docs/src/.vitepress/config.mts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export default defineConfig({
description: 'Documentation for LuxDL Repositories',
cleanUrls: true,
outDir: 'REPLACE_ME_DOCUMENTER_VITEPRESS', // This is required for MarkdownVitepress to work correctly...
lastUpdated: true,

markdown: {
math: true,
Expand All @@ -24,8 +25,28 @@ export default defineConfig({
dark: "github-dark"
},
codeTransformers: [transformerMetaWordHighlight(),],

},

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');`,
],
['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/apple-touch-icon.png' }],
['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: '/favicon-32x32.png' }],
['link', { rel: 'icon', type: 'image/png', sizes: '16x16', href: '/favicon-16x16.png' }],
['link', { rel: 'icon', href: '/favicon.ico' }],
['link', { rel: 'manifest', href: '/site.webmanifest' }],
],

themeConfig: {
outline: 'deep',
// https://vitepress.dev/reference/default-theme-config
Expand Down Expand Up @@ -171,24 +192,6 @@ export default defineConfig({
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');`,
],
['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/apple-touch-icon.png' }],
['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: '/favicon-32x32.png' }],
['link', { rel: 'icon', type: 'image/png', sizes: '16x16', href: '/favicon-16x16.png' }],
['link', { rel: 'manifest', href: '/site.webmanifest' }],
],
lastUpdated: {
text: 'Updated at',
formatOptions: {
Expand Down
3 changes: 1 addition & 2 deletions docs/src/.vitepress/theme/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,10 @@ 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 }) {
enhanceApp({ app }) {
enhanceAppWithTabs(app)
}
} satisfies Theme
4 changes: 2 additions & 2 deletions docs/src/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ hero:
features:
- icon: 🚀
title: Fast & Extendible
details: Lux.jl is written in Julia itself, making it extremely extendible. <u><a href="https://github.com/JuliaGPU/CUDA.jl">CUDA</a></u> and <u><a href="https://github.com/JuliaGPU/AMDGPU.jl">AMDGPU</a></u> are supported first-class, with experimental support for <u><a href="https://github.com/JuliaGPU/Metal.jl">Metal</a></u> Hardware.
details: Lux.jl is written in Julia itself, making it extremely extendible. CUDA and AMDGPU are supported first-class, with experimental support for Metal Hardware.
link: /introduction/
- icon: 🧑‍🔬
title: SciML ❤️ Lux
details: Lux is the default choice for many <u><a href="https://github.com/SciML">SciML</a></u> packages, including DiffEqFlux.jl, NeuralPDE.jl, and more.
details: Lux is the default choice for many SciML packages, including DiffEqFlux.jl, NeuralPDE.jl, and more.
link: https://sciml.ai/
- icon: 🧩
Expand Down

3 comments on commit 849ec40

@avik-pal
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/104284

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.5.32 -m "<description of version>" 849ec40bd359fc35856b7935dc5332ff7af81c62
git push origin v0.5.32

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Benchmark Results

Benchmark suite Current: 849ec40 Previous: b7a0b63 Ratio
Dense(2 => 2)/cpu/forward/NamedTuple/(2, 128) 2001.7 ns 1999.7 ns 1.00
Dense(2 => 2)/cpu/forward/ComponentArray/(2, 128) 1590.4709677419355 ns 1566.2631578947369 ns 1.02
Dense(20 => 20)/cpu/forward/NamedTuple/(20, 128) 4869.142857142857 ns 4977.857142857143 ns 0.98
Dense(20 => 20)/cpu/forward/ComponentArray/(20, 128) 4718.857142857143 ns 4790.285714285715 ns 0.99
Conv((3, 3), 3 => 3)/cpu/forward/NamedTuple/(64, 64, 3, 128) 10357033 ns 10265756 ns 1.01
Conv((3, 3), 3 => 3)/cpu/forward/ComponentArray/(64, 64, 3, 128) 10383988.5 ns 10274883 ns 1.01
vgg16/cpu/forward/NamedTuple/(32, 32, 3, 1) 22706894 ns 22632895 ns 1.00
vgg16/cpu/forward/NamedTuple/(32, 32, 3, 16) 251415835 ns 245920571.5 ns 1.02
vgg16/cpu/forward/NamedTuple/(32, 32, 3, 64) 990621987 ns 972877624 ns 1.02
vgg16/cpu/forward/ComponentArray/(32, 32, 3, 1) 22766979.5 ns 22501168.5 ns 1.01
vgg16/cpu/forward/ComponentArray/(32, 32, 3, 16) 249637390 ns 247109687.5 ns 1.01
vgg16/cpu/forward/ComponentArray/(32, 32, 3, 64) 991675056.5 ns 987921217 ns 1.00
Conv((3, 3), 64 => 64)/cpu/forward/NamedTuple/(64, 64, 64, 128) 371776615 ns 373013391 ns 1.00
Conv((3, 3), 64 => 64)/cpu/forward/ComponentArray/(64, 64, 64, 128) 372349398 ns 369428453 ns 1.01
Conv((3, 3), 1 => 1)/cpu/forward/NamedTuple/(64, 64, 1, 128) 3900400 ns 3929480 ns 0.99
Conv((3, 3), 1 => 1)/cpu/forward/ComponentArray/(64, 64, 1, 128) 3899295 ns 3921774 ns 0.99
Dense(200 => 200)/cpu/forward/NamedTuple/(200, 128) 87314 ns 88845 ns 0.98
Dense(200 => 200)/cpu/forward/ComponentArray/(200, 128) 87424 ns 88585 ns 0.99
Conv((3, 3), 16 => 16)/cpu/forward/NamedTuple/(64, 64, 16, 128) 56912462 ns 56548766 ns 1.01
Conv((3, 3), 16 => 16)/cpu/forward/ComponentArray/(64, 64, 16, 128) 56953662 ns 56536433 ns 1.01
Dense(2000 => 2000)/cpu/forward/NamedTuple/(2000, 128) 6515785 ns 6485167 ns 1.00
Dense(2000 => 2000)/cpu/forward/ComponentArray/(2000, 128) 6560088 ns 6489996.5 ns 1.01

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.