Merge pull request #140 from darsnack/mobilenet-v1

FluxML · Apr 4, 2022 · aba6fb8 · aba6fb8
2 parents f6eb8fe + b278e29
commit aba6fb8
Show file tree

Hide file tree

Showing 18 changed files with 289 additions and 133 deletions.
diff --git a/.github/workflows/Publish.yml b/.github/workflows/Publish.yml
@@ -25,7 +25,7 @@ jobs:
         run: |
           cd gh-pages
           julia --color=yes --project=../docs -e "using Pkg; Pkg.instantiate()"
-          julia --color=yes --project=../docs ../docs/make.jl
+          julia --color=yes --project=../docs -e 'include("../docs/make.jl"); build_and_deploy("dev")'
           git config user.name github-actions
           git config user.email github-actions@github.com
           git add .

diff --git a/.github/workflows/PublishStable.yml b/.github/workflows/PublishStable.yml
@@ -0,0 +1,32 @@
+name: PublishStable
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  publish:
+    name: "Publish Documentation (stable)"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/checkout@v2
+        with:
+          ref: gh-pages
+          path: gh-pages
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: '1.6'
+      - name: Install dependencies
+        run: julia --color=yes --project=. -e 'using Pkg; Pkg.instantiate()'
+      - name: Build and deploy
+        run: |
+          cd gh-pages
+          julia --color=yes --project=../docs -e "using Pkg; Pkg.instantiate()"
+          julia --color=yes --project=../docs -e 'include("../docs/make.jl"); build_and_deploy("stable")'
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+          git add .
+          git commit -m "(stable) Built by Publish.jl."
+          git push
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,6 @@
 # manifests
 docs/Manifest.toml
 Manifest.toml
+
+# docs theme
+_flux-theme
diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "Metalhead"
 uuid = "dbeba491-748d-5e0e-a39e-b530a07fa0cc"
-version = "0.7.0-DEV"
+version = "0.7.0"
 
 [deps]
 Artifacts = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
@@ -27,6 +27,8 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [publish]
 title = "Metalhead.jl"
+theme = "_flux-theme"
+ignore = ["^(gh-pages|juliamnt|julia.dmg)$"]
 
 [targets]
 test = ["Test"]
diff --git a/README.md b/README.md
@@ -16,21 +16,22 @@
 
 | Model Name                                       | Function                                                                                  | Pre-trained? |
 |:-------------------------------------------------|:------------------------------------------------------------------------------------------|:------------:|
-| [VGG](https://arxiv.org/abs/1409.1556)        | [`VGG`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.VGG.html)                 | N            |
-| [ResNet](https://arxiv.org/abs/1512.03385)   | [`ResNet`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.ResNet.html)           | N            |
+| [VGG](https://arxiv.org/abs/1409.1556)           | [`VGG`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.VGG.html)                 | N            |
+| [ResNet](https://arxiv.org/abs/1512.03385)       | [`ResNet`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.ResNet.html)           | N            |
 | [GoogLeNet](https://arxiv.org/abs/1409.4842)     | [`GoogLeNet`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.GoogLeNet.html)     | N            |
 | [Inception-v3](https://arxiv.org/abs/1512.00567) | [`Inception3`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.Inception3.html)   | N            |
 | [SqueezeNet](https://arxiv.org/abs/1602.07360)   | [`SqueezeNet`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.SqueezeNet.html)   | N            |
-| [DenseNet](https://arxiv.org/abs/1608.06993) | [`DenseNet`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.DenseNet.html)       | N            |
-| [ResNeXt](https://arxiv.org/abs/1611.05431)   | [`ResNeXt`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.ResNeXt.html)          | N            |
-| [MobileNetv2](https://arxiv.org/abs/1801.04381)  | [`MobileNetv2`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.MobileNetv2.html)  | N            |
-| [MobileNetv3](https://arxiv.org/abs/1905.02244)  | [`MobileNetv3`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.MobileNetv3.html)  | N            |
-| [MLPMixer](https://arxiv.org/pdf/2105.01601)     | [`MLPMixer`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.MLPMixer.html)     | N            |
-| [ResMLP](https://arxiv.org/abs/2105.03404)     | [`ResMLP`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.ResMLP.html)     | N            |
-| [gMLP](https://arxiv.org/abs/2105.08050)     | [`gMLP`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.gMLP.html)     | N            |
-| [ViT](https://arxiv.org/abs/2010.11929)     | [`ViT`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.ViT.html)     | N            |
-| [ConvNeXt](https://arxiv.org/abs/2201.03545)     | [`ConvNeXt`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.ConvNeXt.html)     | N            |
-| [ConvMixer](https://arxiv.org/abs/2201.09792)     | [`ConvMixer`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.ConvMixer.html)     | N            |
+| [DenseNet](https://arxiv.org/abs/1608.06993)     | [`DenseNet`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.DenseNet.html)       | N            |
+| [ResNeXt](https://arxiv.org/abs/1611.05431)      | [`ResNeXt`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.ResNeXt.html)         | N            |
+| [MobileNetv1](https://arxiv.org/abs/1704.04861)  | [`MobileNetv1`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.MobileNetv1.html) | N            |
+| [MobileNetv2](https://arxiv.org/abs/1801.04381)  | [`MobileNetv2`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.MobileNetv2.html) | N            |
+| [MobileNetv3](https://arxiv.org/abs/1905.02244)  | [`MobileNetv3`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.MobileNetv3.html) | N            |
+| [MLPMixer](https://arxiv.org/pdf/2105.01601)     | [`MLPMixer`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.MLPMixer.html)       | N            |
+| [ResMLP](https://arxiv.org/abs/2105.03404)       | [`ResMLP`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.ResMLP.html)           | N            |
+| [gMLP](https://arxiv.org/abs/2105.08050)         | [`gMLP`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.gMLP.html)               | N            |
+| [ViT](https://arxiv.org/abs/2010.11929)          | [`ViT`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.ViT.html)                 | N            |
+| [ConvNeXt](https://arxiv.org/abs/2201.03545)     | [`ConvNeXt`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.ConvNeXt.html)       | N            |
+| [ConvMixer](https://arxiv.org/abs/2201.09792)    | [`ConvMixer`](https://fluxml.ai/Metalhead.jl/dev/docstrings/Metalhead.ConvMixer.html)     | N            |
 
 ## Getting Started
 

diff --git a/datasets/README.md b/datasets/README.md
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,21 +1,17 @@
 using Pkg
 
 Pkg.develop(path = "..")
-# this is needed since Publish v0.9 breaks our theming hack
-Pkg.pin(name = "Publish", version = "0.8")
 
 using Publish
-using Pkg.Artifacts
+using Artifacts, LazyArtifacts
 using Metalhead
 
 # override default theme
-Publish.Themes.default() = artifact"flux-theme"
+cp(artifact"flux-theme", "../_flux-theme"; force = true)
 
 p = Publish.Project(Metalhead)
 
-# needed to prevent error when overwriting
-rm("dev", recursive = true, force = true)
-rm(p.env["version"], recursive = true, force = true)
-
-# build documentation
-deploy(Metalhead; root = "/Metalhead.jl", force = true, label = "dev")
+function build_and_deploy(label)
+    rm(label; recursive = true, force = true)
+    deploy(Metalhead; root = "/Metalhead.jl", label = label)
+end
diff --git a/docs/serve.jl b/docs/serve.jl
@@ -1,16 +1,15 @@
 using Pkg
 
 Pkg.develop(path = "..")
-# this is needed since Publish v0.9 breaks our theming hack
-Pkg.pin(name = "Publish", version = "0.8")
 
+using Revise
 using Publish
-using Pkg.Artifacts
+using Artifacts, LazyArtifacts
 
 using Metalhead
 
 # override default theme
-Publish.Themes.default() = artifact"flux-theme"
+cp(artifact"flux-theme", "../_flux-theme"; force = true)
 
 p = Publish.Project(Metalhead)
 

diff --git a/src/Metalhead.jl b/src/Metalhead.jl
@@ -44,14 +44,15 @@ export  AlexNet,
         GoogLeNet, Inception3, SqueezeNet,
         DenseNet, DenseNet121, DenseNet161, DenseNet169, DenseNet201,
         ResNeXt,
-        MobileNetv2, MobileNetv3,
+        MobileNetv1, MobileNetv2, MobileNetv3,
         MLPMixer, ResMLP, gMLP,
         ViT,
         ConvNeXt, ConvMixer
 
 # use Flux._big_show to pretty print large models
-for T in (:AlexNet, :VGG, :ResNet, :GoogLeNet, :Inception3, :SqueezeNet, :DenseNet, :ResNeXt,
-          :MobileNetv2, :MobileNetv3, :MLPMixer, :ResMLP, :gMLP, :ViT, :ConvNeXt, :ConvMixer)
+for T in (:AlexNet, :VGG, :ResNet, :GoogLeNet, :Inception3, :SqueezeNet, :DenseNet, :ResNeXt, 
+          :MobileNetv1, :MobileNetv2, :MobileNetv3,
+          :MLPMixer, :ResMLP, :gMLP, :ViT, :ConvNeXt, :ConvMixer)
   @eval Base.show(io::IO, ::MIME"text/plain", model::$T) = _maybe_big_show(io, model)
 end