Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🚀 Instate documentation for MLJFlux #252

Merged
merged 29 commits into from
May 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
103cbb4
🚀 Initialize documentation
EssamWisam May 22, 2024
359cb35
🎨 Add logo
EssamWisam May 22, 2024
56e65fb
🎨 Minor style improvements
EssamWisam May 22, 2024
3946a68
✨ Landing page and style changes
EssamWisam May 22, 2024
ee3e0b8
✨ Add basic docs skeleton and README integration
EssamWisam May 22, 2024
fd8ab78
📝 Add minor improvements
EssamWisam May 22, 2024
fccbfba
Update docs/src/index.md
EssamWisam May 24, 2024
ff5ee4e
Update docs/src/index.md
EssamWisam May 24, 2024
9a0d185
Update docs/src/index.md
EssamWisam May 24, 2024
111d507
Fix quick start by removing fit
EssamWisam May 24, 2024
3df8eb5
Merge branch 'instate-docs' of https://github.com/EssamWisam/MLJFlux.…
EssamWisam May 24, 2024
197dda8
Update docs/src/index.md
EssamWisam May 24, 2024
f2e0d91
Update docs/src/index.md
EssamWisam May 24, 2024
9fd8135
Update docs/src/interface/Summary.md
EssamWisam May 24, 2024
9332eaf
Update docs/src/interface/Custom Builders.md
EssamWisam May 24, 2024
c3b65e9
Update docs/src/interface/Custom Builders.md
EssamWisam May 24, 2024
4ad4ed5
Update docs/src/interface/Custom Builders.md
EssamWisam May 24, 2024
ca78165
Update docs/src/interface/Custom Builders.md
EssamWisam May 24, 2024
e68755c
Update docs/src/interface/Custom Builders.md
EssamWisam May 24, 2024
640ef2c
Update docs/src/workflow examples/Incremental Training.md
EssamWisam May 24, 2024
74e8284
Update docs/src/workflow examples/Incremental Training.md
EssamWisam May 24, 2024
5cc3dcd
Update docs/src/full tutorials/MNIST.md
EssamWisam May 24, 2024
211f505
Update docs/src/full tutorials/MNIST.md
EssamWisam May 24, 2024
2dd1c2a
Update docs/src/full tutorials/MNIST.md
EssamWisam May 24, 2024
8660d5b
Update docs/src/full tutorials/MNIST.md
EssamWisam May 24, 2024
560c748
Update docs/make.jl
EssamWisam May 24, 2024
2c8c2b9
🚑 Minor fixes
EssamWisam May 25, 2024
eb0f3e2
✨ Attempt deployment
EssamWisam May 25, 2024
ec6004f
🚑 Towards documentation
EssamWisam May 25, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/workflows/documenter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Documentation

on:
push:
branches:
- dev
- instate-docs
tags: '*'
pull_request:

jobs:
build:
permissions:
contents: write
pull-requests: read
statuses: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
with:
version: '1.10'
- uses: julia-actions/cache@v1
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
run: julia --project=docs/ docs/make.jl
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,6 @@ and this will require familiarity with the [Flux
API](https://fluxml.ai/Flux.jl/stable/) for defining a neural network
chain.

In the future MLJFlux may provide a larger assortment of canned
builders. Pull requests introducing new ones are most welcome.


### Installation

```julia
Expand Down
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
build/
site/
Loading
Loading