Skip to content

Commit

Permalink
final doc tweaks; no more substantive warnings from Documenter
Browse files Browse the repository at this point in the history
  • Loading branch information
ablaom committed Jun 12, 2024
1 parent 1cda24c commit 6746b8b
Show file tree
Hide file tree
Showing 23 changed files with 1,731 additions and 332 deletions.
10 changes: 10 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
[deps]
CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c"
Imbalance = "c709b415-507b-45b7-9a3d-1767c89fde68"
Languages = "8ef0a80b-9436-5d2c-a485-80b904378c43"
MLDatasets = "eb30cadb-4394-5ae3-aed4-317e484a6458"
MLJ = "add582a8-e3ab-11e8-2d5e-e98b27df1bc7"
MLJDecisionTreeInterface = "c6f25543-311c-4c74-83dc-3ea6d1015661"
MLJFlux = "094fc8d1-fd35-5302-93ea-dabda2abf845"
MLJIteration = "614be32b-d00c-4edb-bd02-1eb411ab5e55"
MLJMultivariateStatsInterface = "1b6a4a23-ba22-4f51-9698-8599985d3728"
MLJXGBoostInterface = "54119dfa-1dab-4055-a167-80440f4f7a91"
MLUtils = "f1d291b0-491e-4a28-83b9-f70985020b54"
Optimisers = "3bd65402-5787-11e9-1adc-39752487f4e2"
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
RDatasets = "ce6b1742-4840-55fa-b093-852dadbb1d8b"
WordTokenizers = "796a5d58-b03d-544a-977e-18100b691f6e"
2 changes: 1 addition & 1 deletion docs/src/common_workflows/architecture_search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@

# Important

Scripts or notebooks in this folder cannot be reliably exectued without the accompanying
Scripts or notebooks in this folder cannot be reliably executed without the accompanying
Manifest.toml and Project.toml files.
2 changes: 1 addition & 1 deletion docs/src/common_workflows/comparison/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@

# Important

Scripts or notebooks in this folder cannot be reliably exectued without the accompanying
Scripts or notebooks in this folder cannot be reliably executed without the accompanying
Manifest.toml and Project.toml files.
2 changes: 1 addition & 1 deletion docs/src/common_workflows/composition/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@

# Important

Scripts or notebooks in this folder cannot be reliably exectued without the accompanying
Scripts or notebooks in this folder cannot be reliably executed without the accompanying
Manifest.toml and Project.toml files.
2 changes: 1 addition & 1 deletion docs/src/common_workflows/early_stopping/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@

# Important

Scripts or notebooks in this folder cannot be reliably exectued without the accompanying
Scripts or notebooks in this folder cannot be reliably executed without the accompanying
Manifest.toml and Project.toml files.
2 changes: 1 addition & 1 deletion docs/src/common_workflows/early_stopping/notebook.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Early Stopping with MLJFlux
# # Early Stopping with MLJ

# This demonstration is available as a Jupyter notebook or julia script
# [here](https://github.com/FluxML/MLJFlux.jl/tree/dev/docs/src/common_workflows/early_stopping).
Expand Down
2 changes: 1 addition & 1 deletion docs/src/common_workflows/hyperparameter_tuning/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@

# Important

Scripts or notebooks in this folder cannot be reliably exectued without the accompanying
Scripts or notebooks in this folder cannot be reliably executed without the accompanying
Manifest.toml and Project.toml files.
2 changes: 1 addition & 1 deletion docs/src/common_workflows/incremental_training/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@

# Important

Scripts or notebooks in this folder cannot be reliably exectued without the accompanying
Scripts or notebooks in this folder cannot be reliably executed without the accompanying
Manifest.toml and Project.toml files.
2 changes: 1 addition & 1 deletion docs/src/common_workflows/live_training/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@

# Important

Scripts or notebooks in this folder cannot be reliably exectued without the accompanying
Scripts or notebooks in this folder cannot be reliably executed without the accompanying
Manifest.toml and Project.toml files.
6 changes: 1 addition & 5 deletions docs/src/extended_examples/MNIST/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# Contents

**Important.** This folder was updated in June 2024 but will no longer be updated.

For the lastest version of this example see [here](/docs/src/full\ tutorials/MNIST).

| file | description |
|:----------------------------|:---------------------------------------------------------|
| `notebook.ipynb` | Juptyer notebook (executed) |
Expand All @@ -15,5 +11,5 @@ For the lastest version of this example see [here](/docs/src/full\ tutorials/MNI

# Important

Scripts or notebooks in this folder cannot be reliably exectued without the accompanying
Scripts or notebooks in this folder cannot be reliably executed without the accompanying
Manifest.toml and Project.toml files.
Loading

0 comments on commit 6746b8b

Please sign in to comment.