Skip to content

Commit

Permalink
fix doctests (#190)
Browse files Browse the repository at this point in the history
* fix docstests

* cleanup

* related packages
  • Loading branch information
CarloLucibello authored Jan 25, 2025
1 parent c50702b commit 1a4fd64
Show file tree
Hide file tree
Showing 10 changed files with 115 additions and 445 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
*.jl.*.cov
*.jl.cov
*.jl.mem
/Manifest.toml
Manifest.toml
docs/build
.vscode
/test.jl
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,20 @@ copied. In fact, while `x` and `y` are materialized arrays,
all the rest are data views.


## Related Packages
## Historical Notes

*MLUtils.jl* brings together functionalities previously found in [LearnBase.jl](https://github.com/JuliaML/LearnBase.jl) , [MLDataPattern.jl](https://github.com/JuliaML/MLDataPattern.jl) and [MLLabelUtils.jl](https://github.com/JuliaML/MLLabelUtils.jl). These packages are now discontinued.

Other features were ported from the deep learning library [Flux.jl](https://github.com/FluxML/Flux.jl), as they are of general use.

[MLJ.jl](https://alan-turing-institute.github.io/MLJ.jl/dev/) is a more complete package for managing the whole machine learning pipeline if you are looking for a sklearn replacement.

## Alternatives and Related Packages

- [MLJ.jl](https://alan-turing-institute.github.io/MLJ.jl/dev/) is a more complete package for managing the whole machine learning pipeline if you are looking for a sklearn replacement.

- [NNlib.jl](https://github.com/FluxML/NNlib.jl) provides utility functions for neural networks.

- [TableTransforms.jl](https://github.com/JuliaML/TableTransforms.jl) contains transformations for tabular datasets.

- [DataAugmentation.jl](https://github.com/FluxML/DataAugmentation.jl). Efficient, composable data augmentation for machine and deep learning with support for n-dimensional images, keypoints and categorical masks.

276 changes: 0 additions & 276 deletions docs/Manifest.toml

This file was deleted.

7 changes: 3 additions & 4 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@ DocMeta.setdocmeta!(MLUtils, :DocTestSetup, :(using MLUtils); recursive=true)

makedocs(;
modules=[MLUtils],
doctest=true,
clean=true,
sitename = "MLUtils.jl",
pages = ["Home" => "index.md",
"API" => "api.md"],
)

deploydocs(repo="github.com/JuliaML/MLUtils.jl.git",
devbranch="main")
rm(joinpath(@__DIR__, "src/index.md"))

deploydocs(repo="github.com/JuliaML/MLUtils.jl.git", devbranch="main")
3 changes: 2 additions & 1 deletion docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ splitobs
falses_like
fill_like
ones_like
rand_like
randn_like
trues_like
zeros_like
```
Expand All @@ -71,7 +73,6 @@ group_counts
group_indices
normalise
rpad_constant
stack
unbatch
unsqueeze
unstack
Expand Down
Loading

0 comments on commit 1a4fd64

Please sign in to comment.