From 8a3d408b7af65fc584b52aab969817a987d8c3b3 Mon Sep 17 00:00:00 2001 From: Lenoctambule <106790775+lenoctambule@users.noreply.github.com> Date: Sun, 29 Mar 2026 19:25:42 +0200 Subject: [PATCH] docs(README.md): update Autoencoder class usage --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index edbd77e..73b1b4e 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,14 @@ $ py mnist_test.py Instatiate an `Autoencoder` object : ```py from autoencoder import Autoencoder +from activations import LeakyReLU -autoencoder = Autoencoder(in_len=300, bottleneck=50, 0.001, relu) +autoencoder = Autoencoder( + [768, 64, 16], + [16, 64, 768], + 0.01, + LeakyReLU() +) ``` And then via the `train_dataset` method to train over a dataset : ```py @@ -31,9 +37,10 @@ autoencoder.train(v) ## Inference -Use your `Autoencoder` object with the `encode` and `decode` methods like so : +Use your `Autoencoder` object with the `encode`, `decode`, `forward` methods like so : ```py example = ... code = autoencoder.encode(example) output = autoencoder.decode(code) +output, code = autoencoder.forward(example) ```