7a32a703f0
853: Improve docs r=CarloLucibello a=janEbert
If you disagree with any of the changes, please tell me what to reverse or fix.
I am unsure about the docstrings I added to `src/utils.jl` for `unsqueeze` and
the `[un]stack` functions so please give those a more detailed look.
Update Documenter.jl version for new features, fix deprecation warnings in
`docs/make.jl` and import Flux for all doctests.
Add missing docstrings to `src/utils.jl`, `src/layers/stateless.jl` and `src/data/`; add
these and other missing functions to Markdown docs.
Improve docstrings by...
- fixing typos,
- removing trailing or double whitespaces,
- using `jldoctest` blocks where applicable,
- fixing, updating or correctly setting up existing doctests,
- improving consistency (for example, always use "# Examples" instead
of other variants),
- removing empty lines between docstrings and functions,
- instead of mentioning keywords, put them into the docstring,
- adding some missing but useful keywords,
- adding references (`@ref`),
- using LaTeX math where applicable, and
- linking papers.
Debatable stuff that is untouched:
- BE/AE s/z irregularities (e.g. "normalise" versus "normalize") since
most papers use the AE version while the Flux source code was
written with BE spelling.
- Names of normalization functions are capitalized
("Batch Normalization" instead of "batch normalization").
- Default values in argument lists have spaces around the equals sign (`arg = x` instead of `arg=x`).
Co-authored-by: janEbert <janpublicebert@posteo.net>
|
||
|---|---|---|
| .github | ||
| docs | ||
| paper | ||
| src | ||
| test | ||
| .gitattributes | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .travis.yml | ||
| CITATION.bib | ||
| LICENSE.md | ||
| Manifest.toml | ||
| NEWS.md | ||
| Project.toml | ||
| README.md | ||
| bors.toml | ||
README.md
Flux is an elegant approach to machine learning. It's a 100% pure-Julia stack, and provides lightweight abstractions on top of Julia's native GPU and AD support. Flux makes the easy things easy while remaining fully hackable.
] add Flux
See the documentation or the model zoo for examples.
If you use Flux in your research, please cite our work.