Skip to content

Commit

Permalink
Merge branch 'instate-docs' of https://github.com/EssamWisam/MLJFlux.jl
Browse files Browse the repository at this point in the history
… into instate-docs
  • Loading branch information
EssamWisam committed May 24, 2024
2 parents 111d507 + 9a0d185 commit 3df8eb5
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MLJFlux.jl

A Julia package integrating deep learning Flux models with MLJ.
A Julia package integrating deep learning Flux models with [MLJ](https://juliaai.github.io/MLJ.jl/dev/).

## Objectives

Expand All @@ -11,7 +11,7 @@ A Julia package integrating deep learning Flux models with MLJ.
- Make it easier to apply machine learning techniques provided by MLJ, including: out-of-sample performance evaluation, hyper-parameter optimization, iteration control, and more, to deep learning models

!!! note "MLJFlux Coverage"
MLJFlux support is focused on fundamental and widely used deep learning models; sophisticated architectures or techniques such as online learning, reinforcement learning, and adversarial networks are currently beyond its scope.
MLJFlux support is focused on fundamental and widely used deep learning models. Sophisticated architectures or techniques such as online learning, reinforcement learning, and adversarial networks are currently beyond its scope.

Also note that MLJFlux is limited to training models only when all training data fits into memory, though it still supports automatic batching of data.

Expand All @@ -25,7 +25,6 @@ Pkg.add(["MLJ", "MLJFlux", "Flux"])
You only need `Flux` if you need to build a custom architecture or experiment with different optimizers, loss functions and activations.

## Quick Start
First load and instantiate mode:
```@example
using MLJ, Flux, MLJFlux
import RDatasets
Expand Down

0 comments on commit 3df8eb5

Please sign in to comment.