Skip to content

Commit 4bbc4e7

Browse files
committed
✨ Improve README, Transformers page and Entity Embedder page
1 parent e85e221 commit 4bbc4e7

File tree

6 files changed

+3231
-1359
lines changed

6 files changed

+3231
-1359
lines changed

.github/workflows/readme-reflect.yml

Lines changed: 0 additions & 32 deletions
This file was deleted.

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "MLJTransforms"
22
uuid = "23777cdb-d90c-4eb0-a694-7c2b83d5c1d6"
33
authors = ["Essam <[email protected]> and contributors"]
4-
version = "0.1.0"
4+
version = "0.1.1"
55

66
[deps]
77
BitBasis = "50ba71b6-fa0f-514d-ae9a-0916efc90dcf"

README.md

Lines changed: 6 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
# MLJTransforms.jl
22

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.
44

5-
## Installation
6-
7-
```julia
8-
import Pkg
9-
Pkg.activate("my_environment", shared=true)
10-
Pkg.add(["MLJ", "MLJTransforms"])
11-
```
5+
[![Build Status](https://github.com/JuliaAI/Imbalance.jl/workflows/CI/badge.svg)](https://github.com/JuliaAI/Imbalance.jl/actions)
6+
[![Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaai.github.io/MLJTransforms.jl/dev/)
127

138
## Quick Start
149

@@ -36,18 +31,7 @@ mach = fit!(machine(encoder, X))
3631
Xnew = transform(mach, X)
3732
```
3833

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.
5235

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

Comments
 (0)