From 7ff8c3a6b15e3127dc50ef0476aa2febaa4c22b9 Mon Sep 17 00:00:00 2001 From: Essam Date: Tue, 5 Mar 2024 02:19:56 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Improve=20documentation=20#89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 1 + docs/src/index.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/README.md b/README.md index 68728e63..170fa168 100644 --- a/README.md +++ b/README.md @@ -124,6 +124,7 @@ Xyover, cache = TableTransforms.apply(oversampler, Xy) # equivalently ``` The `reapply(oversampler, Xy, cache)` method from `TableTransforms` simply falls back to `apply(oversample, Xy)` and the `revert(oversampler, Xy, cache)` reverts the transform by removing the oversampled observations from the table. +Notice that because the interfaces of `MLJ` and `TableTransforms` use the same model names, you will have to specify the source of the model if both are used in the same file (e.g., `Imbalance.TableTransforms.SMOTE`) for the example above. ## 🎨 Features - Supports multi-class variants of the algorithms and both nominal and continuous features diff --git a/docs/src/index.md b/docs/src/index.md index 0f78cdce..ef375ebf 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -118,6 +118,8 @@ Xyover, cache = TableTransforms.apply(oversampler, Xy) # equivalently ``` The `reapply(oversampler, Xy, cache)` method from `TableTransforms` simply falls back to `apply(oversample, Xy)` and the `revert(oversampler, Xy, cache)` reverts the transform by removing the oversampled observations from the table. +Notice that because the interfaces of `MLJ` and `TableTransforms` use the same model names, you will have to specify the source of the model if both are used in the same file (e.g., `Imbalance.TableTransforms.SMOTE`) for the example above. + ## Features - Supports multi-class variants of the algorithms and both nominal and continuous features