Aggregate changes for v1

.github/workflows/CI.yml

@@ -154,8 +154,6 @@ jobs:
         with:
           version: ${{ matrix.version }}
       - uses: julia-actions/julia-downgrade-compat@v1
-        with:
-          skip: 'AMDGPU'
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
         env:

Project.toml

@@ -1,7 +1,7 @@
 name = "Lux"
 uuid = "b2108857-7c20-44ae-9111-449ecde12c47"
 authors = ["Avik Pal <[email protected]> and contributors"]
-version = "0.5.68"
+version = "1.0.0"
 
 [deps]
 ADTypes = "47edcb42-4c32-4615-8424-f2b9edc5f35b"
@@ -20,7 +20,6 @@ GPUArraysCore = "46192b85-c4d5-4398-a991-12ede77f4527"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 LossFunctions = "30fc2ffe-d236-52d8-8643-a9d8f7c094a7"
 LuxCore = "bb33d45b-7691-41d6-9220-0943567d0623"
-LuxDeviceUtils = "34f89e08-e1d5-43b4-8944-0b49ac560553"
 LuxLib = "82251201-b29d-42c6-8e01-566dec8acb11"
 MLDataDevices = "7e8f7934-dd98-4c1a-8fe8-92b47a384d40"
 MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
@@ -42,7 +41,6 @@ WeightInitializers = "d49dbf32-c5c2-4618-8acc-27bb2598ef2d"
 [weakdeps]
 CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba"
 ComponentArrays = "b0b7db55-cfe3-40fc-9ded-d10e2dbeff66"
-DynamicExpressions = "a40a106e-89c9-4ca8-8020-a735e8728b6b"
 Enzyme = "7da242da-08ed-463a-9acd-ee780be4f1d9"
 Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c"
 FunctionWrappers = "069b7b12-0de2-55c6-9aab-29f3d0a68a2e"
@@ -56,7 +54,6 @@ Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
 
 [extensions]
 LuxComponentArraysExt = "ComponentArrays"
-LuxDynamicExpressionsExt = "DynamicExpressions"
 LuxEnzymeExt = "Enzyme"
 LuxFluxExt = "Flux"
 LuxMLUtilsExt = "MLUtils"
@@ -70,15 +67,14 @@ LuxZygoteExt = "Zygote"
 [compat]
 ADTypes = "1.5"
 Adapt = "4"
-ArgCheck = "2.1"
+ArgCheck = "2.3"
 ArrayInterface = "7.9"
 CUDA = "5.3.2"
 ChainRulesCore = "1.24"
 Compat = "4.15"
 ComponentArrays = "0.15.16"
 ConcreteStructs = "0.2.3"
 DispatchDoctor = "0.4.12"
-DynamicExpressions = "0.16, 0.17, 0.18, 0.19"
 Enzyme = "0.12.26"
 EnzymeCore = "0.7.7"
 FastClosures = "0.3.2"
@@ -89,9 +85,8 @@ Functors = "0.4.12"
 GPUArraysCore = "0.1.6"
 LinearAlgebra = "1.10"
 LossFunctions = "0.11.1"
-LuxCore = "0.1.24"
-LuxDeviceUtils = "0.1.26"
-LuxLib = "0.3.42"
+LuxCore = "1"
+LuxLib = "1.2"
 MLDataDevices = "1.1"
 MLUtils = "0.4.4"
 MPI = "0.20.19"
@@ -104,7 +99,7 @@ Preferences = "1.4.3"
 Random = "1.10"
 Reexport = "1.2.2"
 ReverseDiff = "1.15"
-SIMDTypes = "0.1.0"
+SIMDTypes = "0.1"
 Setfield = "1.1.1"
 SimpleChains = "0.4.7"
 Static = "1.1.1"
@@ -113,6 +108,6 @@ Statistics = "1.10"
 Tracker = "0.2.34"
 UnrolledUtilities = "0.1.2"
 VectorizationBase = "0.21.70"
-WeightInitializers = "0.1.5, 1"
+WeightInitializers = "1"
 Zygote = "0.6.70"
 julia = "1.10"

README.md

@@ -37,6 +37,9 @@ import Pkg
 Pkg.add("Lux")
 ```
 
+> [!TIP]
+> If you are using a pre-v1 version of Lux.jl, please see the [Updating to v1 section](https://lux.csail.mit.edu/dev/introduction/updating_to_v1/) for instructions on how to update.
+
 ## 🤸 Quickstart
 
 ```julia

benchmarks/setup.jl

@@ -1,6 +1,6 @@
 using ADTypes: ADTypes, AutoEnzyme, AutoZygote
 using Adapt: adapt
-using Lux: Lux, BatchNorm, Chain, Conv, CrossCor, Dense, Dropout, FlattenLayer, MaxPool
+using Lux: Lux, BatchNorm, Chain, Conv, Dense, Dropout, FlattenLayer, MaxPool
 using MLDataDevices: AbstractDevice, CPUDevice, CUDADevice, AMDGPUDevice
 using NNlib: relu, gelu
 using Random: Random

benchmarks/setups/models.jl

@@ -25,10 +25,10 @@ function setup_vgg16_benchmarks!(suite::BenchmarkGroup, cpu_or_gpu::String,
             conv_bn((3, 3), 512 => 512, relu; pad=(1, 1), stride=(1, 1)),
             conv_bn((3, 3), 512 => 512, relu; pad=(1, 1), stride=(1, 1)),
             conv_bn((3, 3), 512 => 512, relu; pad=(1, 1), stride=(1, 1)),
-            MaxPool((2, 2)); disable_optimizations=true),
+            MaxPool((2, 2))),
         FlattenLayer(),
         Chain(Dense(512, 4096, relu), Dropout(0.5f0), Dense(4096, 4096, relu),
-            Dropout(0.5f0), Dense(4096, 10); name="Classifier"); disable_optimizations=true)
+            Dropout(0.5f0), Dense(4096, 10); name="Classifier"))
 
     for bsize in (32, 64, 128)
         setup_forward_pass_benchmark!(suite, "vgg16(32, 32, 3, $bsize)",

docs/Project.toml

@@ -14,7 +14,6 @@ Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 Lux = "b2108857-7c20-44ae-9111-449ecde12c47"
 LuxCUDA = "d0bbae9a-e099-4d5b-a835-1c6931763bda"
 LuxCore = "bb33d45b-7691-41d6-9220-0943567d0623"
-LuxDeviceUtils = "34f89e08-e1d5-43b4-8944-0b49ac560553"
 LuxLib = "82251201-b29d-42c6-8e01-566dec8acb11"
 LuxTestUtils = "ac9de150-d08f-4546-94fb-7472b5760531"
 MLDataDevices = "7e8f7934-dd98-4c1a-8fe8-92b47a384d40"
@@ -39,18 +38,17 @@ GPUArraysCore = "0.1"
 KernelAbstractions = "0.9"
 LinearAlgebra = "1.10"
 Literate = "2.18.0"
-Lux = "0.5.62"
+Lux = "1"
 LuxCUDA = "0.3.2"
-LuxCore = "0.1.15"
-LuxDeviceUtils = "0.1.21"
-LuxLib = "0.3.42"
+LuxCore = "1"
+LuxLib = "1"
 LuxTestUtils = "1.1"
 MLDataDevices = "1.1"
 Optimisers = "0.3.3"
 Pkg = "1.10"
 Printf = "1.10"
 Random = "1.10"
 StaticArrays = "1"
-WeightInitializers = "0.1.7, 1"
+WeightInitializers = "1"
 Zygote = "0.6.70"
 julia = "1.10"

docs/make.jl

@@ -1,7 +1,6 @@
 using Documenter, DocumenterVitepress, Pkg
 using Lux, LuxCore, LuxLib, WeightInitializers
-using LuxTestUtils, LuxDeviceUtils
-using MLDataDevices
+using LuxTestUtils, MLDataDevices
 using LuxCUDA
 
 using Optimisers # for some docstrings
@@ -15,6 +14,7 @@ pages = [
         "Introduction" => "introduction/index.md",
         "Overview" => "introduction/overview.md",
         "Resources" => "introduction/resources.md",
+        "Updating to v1" => "introduction/updating_to_v1.md",
         "Citation" => "introduction/citation.md"
     ],
     "Tutorials" => [
@@ -31,8 +31,7 @@ pages = [
             "tutorials/intermediate/3_HyperNet.md"
         ],
         "Advanced" => [
-            "tutorials/advanced/1_GravitationalWaveForm.md",
-            "tutorials/advanced/2_SymbolicOptimalControl.md"
+            "tutorials/advanced/1_GravitationalWaveForm.md"
         ]
     ],
     "Manual" => [
@@ -56,7 +55,6 @@ pages = [
             "api/Lux/distributed_utils.md",
         ],
         "Accelerator Support" => [
-            "api/Accelerator_Support/LuxDeviceUtils.md",
             "api/Accelerator_Support/MLDataDevices.md"
         ],
         "Building Blocks" => [
@@ -80,8 +78,7 @@ makedocs(; sitename="Lux.jl Docs",
     authors="Avik Pal et al.",
     clean=true,
     doctest=false,  # We test it in the CI, no need to run it here
-    modules=[Lux, LuxCore, LuxLib, WeightInitializers,
-        LuxTestUtils, LuxDeviceUtils, MLDataDevices],
+    modules=[Lux, LuxCore, LuxLib, WeightInitializers, LuxTestUtils, MLDataDevices],
     linkcheck=true,
     repo="https://github.com/LuxDL/Lux.jl/blob/{commit}{path}#{line}",
     format=DocumenterVitepress.MarkdownVitepress(;

docs/run_single_tutorial.jl

@@ -24,13 +24,13 @@ function preprocess(path, str)
     using InteractiveUtils
     InteractiveUtils.versioninfo()
 
-    if @isdefined(LuxDeviceUtils)
-        if @isdefined(CUDA) && LuxDeviceUtils.functional(LuxCUDADevice)
+    if @isdefined(MLDataDevices)
+        if @isdefined(CUDA) && MLDataDevices.functional(CUDADevice)
             println()
             CUDA.versioninfo()
         end
 
-        if @isdefined(AMDGPU) && LuxDeviceUtils.functional(LuxAMDGPUDevice)
+        if @isdefined(AMDGPU) && MLDataDevices.functional(AMDGPUDevice)
             println()
             AMDGPU.versioninfo()
         end

docs/src/.vitepress/config.mts

@@ -6,7 +6,7 @@ import { transformerMetaWordHighlight } from '@shikijs/transformers';
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
-    base: 'REPLACE_ME_DOCUMENTER_VITEPRESS',// TODO: replace this in makedocs!
+    base: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
     title: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
     description: 'Documentation for LuxDL Repositories',
     cleanUrls: true,
@@ -79,7 +79,6 @@ export default defineConfig({
                     },
                     {
                         text: 'Accelerator Support', items: [
-                            { text: 'LuxDeviceUtils', link: '/api/Accelerator_Support/LuxDeviceUtils' },
                             { text: 'MLDataDevices', link: '/api/Accelerator_Support/MLDataDevices' }
                         ]
                     },
@@ -112,6 +111,7 @@ export default defineConfig({
                     { text: 'Introduction', link: '/introduction' },
                     { text: 'Overview', link: '/introduction/overview' },
                     { text: 'Resources', link: '/introduction/resources' },
+                    { text: 'Updating to v1', link: '/introduction/updating_to_v1' },
                     { text: 'Citation', link: '/introduction/citation' }]
             },
             "/tutorials/": {
@@ -132,8 +132,7 @@ export default defineConfig({
                     },
                     {
                         text: 'Advanced', collapsed: false, items: [
-                            { text: 'Training a Neural ODE to Model Gravitational Waveforms', link: '/tutorials/advanced/1_GravitationalWaveForm' },
-                            { text: 'Solving Optimal Control Problems with Symbolic UDEs', link: '/tutorials/advanced/2_SymbolicOptimalControl' },]
+                            { text: 'Training a Neural ODE to Model Gravitational Waveforms', link: '/tutorials/advanced/1_GravitationalWaveForm' },]
                     },
                     {
                         text: 'Large Models', collapsed: true, items: [
@@ -216,7 +215,6 @@ export default defineConfig({
                     },
                     {
                         text: 'Accelerator Support', collapsed: false, items: [
-                            { text: 'LuxDeviceUtils', link: '/api/Accelerator_Support/LuxDeviceUtils' },
                             { text: 'MLDataDevices', link: '/api/Accelerator_Support/MLDataDevices' }]
                     },
                     {

docs/src/api/Accelerator_Support/MLDataDevices.md

@@ -3,7 +3,7 @@
 `MLDataDevices.jl` is a lightweight package defining rules for transferring data across
 devices. Most users should directly use Lux.jl instead.
 
-!!! note "Comparison to LuxDeviceUtils.jl"
+!!! note "Transitioning from `LuxDeviceUtils.jl`"
 
     `LuxDeviceUtils.jl` was renamed to `MLDataDevices.jl` in v1.0 as a part of allowing
     these packages to have broader adoption outsize the Lux community. However, Lux

docs/src/api/Building_Blocks/LuxCore.md

@@ -14,8 +14,9 @@ Pages = ["LuxCore.md"]
 ## Abstract Types
 
 ```@docs
-LuxCore.AbstractExplicitLayer
-LuxCore.AbstractExplicitContainerLayer
+LuxCore.AbstractLuxLayer
+LuxCore.AbstractLuxWrapperLayer
+LuxCore.AbstractLuxContainerLayer
 ```
 
 ## General
@@ -49,12 +50,6 @@ LuxCore.update_state
 
 ## Layer size
 
-!!! warning
-
-    These specifications have been added very recently and most layers currently do not
-    implement them.
-
 ```@docs
-LuxCore.inputsize
 LuxCore.outputsize
 ```

docs/src/api/Building_Blocks/LuxLib.md

@@ -1,4 +1,4 @@
-# LuxLib
+# [LuxLib](@id LuxLib-API)
 
 Backend for Lux.jl
 

docs/src/api/Lux/contrib.md

@@ -8,12 +8,6 @@ All features listed on this page are **experimental** which means:
    experimental sooner.
 3. None of the features are exported.
 
-!!! warning
-
-    Starting v"0.5.2" all Experimental features need to be accessed via
-    `Lux.Experimental.<feature>`. Direct access via `Lux.<feature>` will be removed in
-    v"0.6".
-
 ## Index
 
 ```@index
@@ -22,11 +16,6 @@ Pages = ["contrib.md"]
 
 ## Parameter Freezing
 
-!!! info
-
-    In the long term, this will be supported via
-    [Optimisers.jl](https://github.com/FluxML/Optimisers.jl/pull/49).
-
 ```@docs
 Lux.Experimental.FrozenLayer
 Lux.Experimental.freeze
@@ -39,7 +28,6 @@ For detailed usage example look at the [manual page](@ref freezing-model-paramet
 
 ```@docs
 Lux.Experimental.layer_map
-Lux.Experimental.@layer_map
 ```
 
 ## Debugging Functionality
@@ -56,15 +44,3 @@ Lux.Experimental.DebugLayer
 ```@docs
 Lux.Experimental.share_parameters
 ```
-
-## StatefulLuxLayer
-
-[`Lux.StatefulLuxLayer`](@ref) used to be part of experimental features, but has been
-promoted to stable API. It is now available via `Lux.StatefulLuxLayer`. Change all uses of
-`Lux.Experimental.StatefulLuxLayer` to `Lux.StatefulLuxLayer`.
-
-## Compact Layer API
-
-[`Lux.@compact`](@ref) used to be part of experimental features, but has been promoted to
-stable API. It is now available via `Lux.@compact`. Change all uses of
-`Lux.Experimental.@compact` to `Lux.@compact`.