|
1 | 1 | # MLJTransforms.jl |
2 | 2 |
|
3 | | -A Julia package providing a wide range of categorical encoders and transformers to be used with the [MLJ](https://juliaai.github.io/MLJ.jl/dev/) package. Transformers help convert raw features into a representation that's better suited for downstream models. Meanwhile, categorical encoders are a type of transformer that specifically encodes categorical features into numerical forms. |
| 3 | +A Julia package providing a wide range of categorical encoders and data transformers to be used with the [MLJ](https://juliaai.github.io/MLJ.jl/dev/) package. |
4 | 4 |
|
5 | | -## Installation |
6 | | - |
7 | | -```julia |
8 | | -import Pkg |
9 | | -Pkg.activate("my_environment", shared=true) |
10 | | -Pkg.add(["MLJ", "MLJTransforms"]) |
11 | | -``` |
| 5 | +[](https://github.com/JuliaAI/Imbalance.jl/actions) |
| 6 | +[](https://juliaai.github.io/MLJTransforms.jl/dev/) |
12 | 7 |
|
13 | 8 | ## Quick Start |
14 | 9 |
|
@@ -36,18 +31,7 @@ mach = fit!(machine(encoder, X)) |
36 | 31 | Xnew = transform(mach, X) |
37 | 32 | ``` |
38 | 33 |
|
39 | | -## Available Transformers |
40 | | -See [complete list](transformers/all_transformers) of transformers in this package. |
41 | | - |
42 | | -In `MLJTransforms` we denote transformers that can operate on columns with `Continuous` and/or `Count` [scientific types](https://juliaai.github.io/ScientificTypes.jl/dev/) as *numerical transformers*. Meanwhile, *categorical transformers* operate on `Multiclass` and/or `OrderedFactor` [scientific types](https://juliaai.github.io/ScientificTypes.jl/dev/). Most categorical transformers in this package operate by converting categorical values into numerical values or vectors, and are therefore considered categorical encoders. We categorize categorical encoders as follows: |
43 | | - |
44 | | - |
45 | | -| **Category** | **Description** | |
46 | | -|:---------------------------:|:-------------------------------------------------------------------------------:| |
47 | | -| [Classical Encoders](transformers/classical.md) | Traditional categorical encoding algorithms and techniques. | |
48 | | -| [Neural-based Encoders](transformers/neural) | Categorical encoders based on neural networks. | |
49 | | -| [Contrast Encoders](transformers/contrast.md) | Categorical encoders that could be modeled via a contrast matrix. | |
50 | | -| [Utility Encoders](transformers/utility.md) | Categorical encoders meant to be used as preprocessors for other transformers or models.| |
51 | | - |
| 34 | +See the full [documentation](https://juliaai.github.io/MLJTransforms.jl/dev/) for more information and a [full list](https://juliaai.github.io/MLJTransforms.jl/dev/all_transformers) of transformers in this package. |
52 | 35 |
|
53 | | -Some transformers in this package can even operate on both `Finite` and `Infinite` scientific types or other special scientific types (eg, to represent time). To learn more about scientific types see [the official documentation](https://juliaai.github.io/ScientificTypes.jl/dev/#Type-hierarchy). |
| 36 | +## 👥 Credits |
| 37 | +This package was created by [Essam Wisam](https://github.com/JuliaAI) as a Google Summer of Code project on categorical encoding, under the mentorship of [Anthony Blaom](https://ablaom.github.io). Subsequently, the package was expanded to include data transformation methods beyond categorical encoders that previously existed in other packages. |
0 commit comments