Merge pull request #19 from JuliaAI/docs

🌟 Initialize documentation

Author: EssamWisam

.github/workflows/documenter.yml

@@ -0,0 +1,36 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - dev
+      - main
+    tags: '*'
+  pull_request:
+
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+jobs:
+  build:
+    permissions:
+      contents: write
+      pull-requests: read
+      statuses: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1.10'
+      - uses: julia-actions/cache@v1
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
+        run: julia --project=docs/ docs/make.jl

.gitignore

@@ -28,3 +28,8 @@ meh/*.ipynb
 /*.jl
 scratchpad/
 examples/test.jl
+catboost_info/**
+/catboost_info
+/catboost_info
+/docs/src/tutorials/adult_example/.CondaPkg
+/docs/src/tutorials/adult_example/catboost_info

Project.toml

@@ -1,6 +1,7 @@
 name = "MLJTransforms"
 uuid = "23777cdb-d90c-4eb0-a694-7c2b83d5c1d6"
 authors = ["Essam <[email protected]> and contributors"]
+
 version = "0.1.2"
 
 [deps]

README.md

@@ -1,3 +1,40 @@
+# MLJTransforms.jl
+
 ![logg](https://github.com/JuliaAI/MLJTransforms/assets/49572294/8d119672-e641-4971-884d-dcb793ba0c05)
 
-Preprocessing, transformation and encoding techniques for MLJ.
+
+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.
+
+[![Build Status](https://github.com/JuliaAI/Imbalance.jl/workflows/CI/badge.svg)](https://github.com/JuliaAI/Imbalance.jl/actions)
+[![Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaai.github.io/MLJTransforms.jl/dev/)
+
+## Quick Start
+
+For the following demo, you will need to additionally run `Pkg.add("RDatasets")`.
+
+```julia
+using MLJ, MLJTransforms
+import RDatasets
+
+# 1. Load Data
+X = RDatasets.dataset("HSAUR", "Forbes2000");
+
+# 2. Load the model
+FrequencyEncoder = @load FrequencyEncoder pkg="MLJTransforms"
+encoder = FrequencyEncoder(
+    features=[:Country, :Category],     # The categorical columns to select
+    ignore=false,                       # Whether to exclude or include selected columns
+    ordered_factor = false,             # Whether to also encode columns of ordered factor elements
+    normalize=true                      # Whether to normalize the frequencies used for encoding
+    )
+
+
+# 3. Wrap it in a machine and fit
+mach = fit!(machine(encoder, X))
+Xnew = transform(mach, X)
+```
+
+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.
+
+## 👥 Credits
+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.

docs/.gitignore

@@ -0,0 +1,2 @@
+build/
+site/