Skip to content

Commit

Permalink
Merge pull request #92 from JuliaAI/master
Browse files Browse the repository at this point in the history
Master
  • Loading branch information
EssamWisam authored Mar 5, 2024
2 parents f187000 + 7ff8c3a commit 96b1cbb
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 2 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions src/common/docs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,7 @@ const COMMON_DOCS = Dict(

"K" => """
- `k::Integer=5`: Number of nearest neighbors to consider in the algorithm. Should be within the range """*
"""`0 < k < n` where n is the number of observations in the smallest class. It will be automatically set to """*
"""`m-1` for any class with `m` points where `m ≤ k`.
"""`0 < k < n` where n is the number of observations in the smallest class.
""",
"K-FULL" => """
- `k::Integer=5`: Number of nearest neighbors to consider in the algorithm. Should be within the range """*
Expand Down

0 comments on commit 96b1cbb

Please sign in to comment.