Skip to content

Generate the estimator tables from one source #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xhan97 merged 1 commit into from
Aug 16, 2026
Merged

Generate the estimator tables from one source #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,9 @@ jobs:

- name: Run linter
run: uv run ruff check .

# The pre-commit hook only helps people who installed it. This is the gate:
# the root README is outside MkDocs, so nothing else notices it drifting
# from the package.
- name: Check the estimator tables match the package
run: uv run --no-sync python scripts/sync_readme_tables.py --check
11 changes: 11 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,17 @@ repos:
hooks:
- id: black

- repo: local
hooks:
# The root README never passes through MkDocs, so no plugin can keep its
# estimator tables in step with the docs. CI runs the same check.
- id: sync-readme-tables
name: estimator tables are current
entry: uv run python scripts/sync_readme_tables.py --check
language: system
pass_filenames: false
files: ^(README\.md|docs/README\.md|scripts/estimators\.py|ikpykit/.*/__init__\.py)$

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0
hooks:
Expand Down
102 changes: 52 additions & 50 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,74 +82,76 @@ clf.predict([[0.1, 0.3], [0, 0.7], [90, 85]])

## Implemented Algorithms

<!-- BEGIN GENERATED ALGORITHMS -->

#### Summary

| Algorithms | Kernel Similarity | Anomaly Detection | Clustering | Change Detection |
| --------------- | ------------------------------ | -------------------------- | -------------------- | ---------------- |
| Point Data | IsoKernel (AAAI'19, SIGKDD'18) | IForest (ICDM'08, TKDD'12) | IDKC (IS'23) | |
| | | INNE (CIJ'18) | PSKC (TKDE'23) | |
| | | IDKD (TKDE'22) | IKAHC (PRJ'23) | |
| Graph Data | IsoGraphKernel (AAAI'21) | IKGOD (SIAM'23) | | |
| Group Data | IsodisKernel (SIGKDD'20) | IKGAD (TKDE'22) | | |
| Stream Data | | | StreaKHC (SIGKDD'22) | ICID (JAIR'24) |
| Time Series | | IKTOD (VLDB'22) | | |
| Trajectory Data | | IKAT (JAIR'24) | TIDKC (ICDM'23) | |
| Algorithms | Kernel Similarity | Anomaly Detection | Clustering | Change Detection |
| --- | --- | --- | --- | --- |
| Point Data | IsoKernel (AAAI'19, SIGKDD'18) | IForest (ICDM'08, TKDD'12)<br>INNE (CIJ'18)<br>IDKD (TKDE'22) | IDKC (IS'23)<br>PSKC (TKDE'23)<br>IKAHC (PR'23) | |
| Graph Data | IsoGraphKernel (AAAI'21) | IKGOD (SIAM'23) | | |
| Group Data | IsoDisKernel (SIGKDD'20) | IKGAD (TKDE'22) | | |
| Stream Data | | | STREAMKHC (SIGKDD'22) | ICID (JAIR'24) |
| Time Series | | IKTOD (VLDB'22) | | |
| Trajectory Data | | IKAT (JAIR'24) | TIDKC (ICDM'23) | |

**(i) Isolation Kernel**:

**(i) Isolation Kernel** :
| Abbr | Algorithm | Application | Publication |
| --- | --- | --- | --- |
| [IsoDisKernel](https://isolationkernel.github.io/ikpykit/latest/api/kernel/isodiskernel.html) | Isolation Distribution Kernel | Distribution similarity calculating | SIGKDD2020 |
| [IsoKernel](https://isolationkernel.github.io/ikpykit/latest/api/kernel/isokernel.html) | Isolation Kernel | IK feature mapping and similarity calculating | AAAI2019, SIGKDD2018 |

| Abbr | Algorithm | Application | Publication |
| ---------------------------------------------------------------------------------------------- | ----------------------------- | --------------------------------------------- | -------------------- |
| [IsoKernel](https://isolationkernel.github.io/ikpykit/latest/api/kernel/isolation_kernel.html) | Isolation Kernel | IK feature mapping and similarity calculating | AAAI2019, SIGKDD2018 |
| [IsoDisKernel](https://isolationkernel.github.io/ikpykit/latest/api/kernel/isolation_dis_kernel.html) | Isolation Distribution Kernel | Distribution similarity calculating | SIGKDD2020 |
**(ii) Point Anomaly Detection**:

**(ii) Point Anomaly detection** :
| Abbr | Algorithm | Application | Publication |
| --- | --- | --- | --- |
| [IDKD](https://isolationkernel.github.io/ikpykit/latest/api/anomaly/idkd.html) | Isolation Distributional Kernel for point anomaly detections | Anomaly Detection | TKDE2022 |
| [INNE](https://isolationkernel.github.io/ikpykit/latest/api/anomaly/inne.html) | Isolation-based anomaly detection using nearest-neighbor ensembles | Anomaly Detection | CIJ2018 |
| [IForest](https://isolationkernel.github.io/ikpykit/latest/api/anomaly/iforest.html) | Isolation forest | Anomaly Detection | ICDM2008, TKDD2012 |

| Abbr | Algorithm | Application | Publication |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------ | ----------------- | ------------------ |
| [IForest](https://isolationkernel.github.io/ikpykit/latest/api/anomaly/iforest.html) | Isolation forest | Anomaly Detection | ICDM2008, TKDD2022 |
| [INNE](https://isolationkernel.github.io/ikpykit/latest/api/anomaly/inne.html) | Isolation-based anomaly detection using nearest-neighbor ensembles | Anomaly Detection | CIJ2018 |
| [IDKD](https://isolationkernel.github.io/ikpykit/latest/api/anomaly/idkd.html) | Isolation Distributional Kernel for point anomaly detections | Anomaly Detection | TKDE2022 |
**(iii) Point Clustering**:

**(iii) Point Clustering** :
| Abbr | Algorithm | Application | Publication |
| --- | --- | --- | --- |
| [IDKC](https://isolationkernel.github.io/ikpykit/latest/api/cluster/idkc.html) | Kernel-based Clustering via Isolation Distributional Kernel | Point Clustering | IS2023 |
| [IKAHC](https://isolationkernel.github.io/ikpykit/latest/api/cluster/ikahc.html) | Isolation Kernel for Agglomerative Hierarchical Clustering | Hierarchical Clustering | PR2023 |
| [PSKC](https://isolationkernel.github.io/ikpykit/latest/api/cluster/pskc.html) | Point-set Kernel Clustering | Point Clustering | TKDE2023 |

| Abbr | Algorithm | Application | Publication |
| ------------------------------------------------------------------------- | ------------------------------------------------------------ | ----------------------- | ----------- |
| [IDKC](https://isolationkernel.github.io/ikpykit/latest/api/cluster/idkc.html) | Kernel-based Clustering via Isolation Distributional Kernel. | Point Clustering | IS2023 |
| [PSKC](https://isolationkernel.github.io/ikpykit/latest/api/cluster/pskc.html) | Point-set Kernel Clustering | Point Clustering | TKDE2023 |
| [IKAHC](https://isolationkernel.github.io/ikpykit/latest/api/cluster/ikahc.html) | Isolation Kernel for Agglomerative Hierarchical Clustering | Hierarchical Clustering | PR2023 |
**(iv) Graph Mining**:

**(IV) Graph Data** :
| Abbr | Algorithm | Application | Publication |
| --- | --- | --- | --- |
| [IKGOD](https://isolationkernel.github.io/ikpykit/latest/api/graph/ikgod.html) | Subgraph Centralization: A Necessary Step for Graph Anomaly Detection | Graph Anomaly Detection | SIAM2023 |
| [IsoGraphKernel](https://isolationkernel.github.io/ikpykit/latest/api/graph/isographkernel.html) | Isolation Graph Kernel | Graph IK embedding and similarity calculating | AAAI2021 |

| Abbr | Algorithm | Application | Publication |
| ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | --------------------------------------------- | ----------- |
| [IKGOD](https://isolationkernel.github.io/ikpykit/latest/api/graph/ikgod.html) | Subgraph Centralization: A Necessary Step for Graph Anomaly Detection. | Graph Anomaly Detection | SIAM2023 |
| [IsoGraphKernel](https://isolationkernel.github.io/ikpykit/latest/api/graph/IsoGraphKernel.html) | Isolation Graph Kernel | Graph IK embedding and similarity calculating | AAAI2021 |
**(v) Group Mining**:

**(V) Group Data** :
| Abbr | Algorithm | Application | Publication |
| --- | --- | --- | --- |
| [IKGAD](https://isolationkernel.github.io/ikpykit/latest/api/group/ikgad.html) | Isolation Distributional Kernel for group anomaly detections | Group Anomaly Detection | TKDE2022 |

| Abbr | Algorithm | Application | Publication |
| ----------------------------------------------------------------------- | ------------------------------------------------------------ | ----------------------- | ----------- |
| [IKGAD](https://isolationkernel.github.io/ikpykit/latest/api/group/ikgad.html) | Isolation Distributional Kernel for group anomaly detections | Group Anomaly Detection | TKDE2022 |
**(vi) Stream Mining**:

**(VI) Stream Data** :
| Abbr | Algorithm | Application | Publication |
| --- | --- | --- | --- |
| [ICID](https://isolationkernel.github.io/ikpykit/latest/api/stream/icid.html) | Detecting change intervals with isolation distributional kernel | Change Intervals Detection | JAIR2024 |
| [STREAMKHC](https://isolationkernel.github.io/ikpykit/latest/api/stream/streamkhc.html) | Streaming Hierarchical Clustering Based on Point-Set Kernel | Online Hierarchical Clustering | SIGKDD2022 |

| Abbr | Algorithm | Application | Publication |
| ------------------------------------------------------------------------------ | --------------------------------------------------------------- | ------------------------------ | ----------- |
| [StreaKHC](https://isolationkernel.github.io/ikpykit/latest/api/stream/streakhc.html) | Isolation Distribution Kernel for Trajectory Anomaly Detections | Online Hierarchical Clustering | SIGKDD2022 |
| [ICID](https://isolationkernel.github.io/ikpykit/latest/api/stream/icid.html) | Detecting change intervals with isolation distributional kernel | Change Intervals Detection | JAIR2024 |
**(vii) Trajectory Mining**:

**(VII) Trajectory Data** :
| Abbr | Algorithm | Application | Publication |
| --- | --- | --- | --- |
| [IKAT](https://isolationkernel.github.io/ikpykit/latest/api/trajectory/ikat.html) | Isolation Distribution Kernel for Trajectory Anomaly Detections | Trajectory Anomaly Detection | JAIR2024 |
| [TIDKC](https://isolationkernel.github.io/ikpykit/latest/api/trajectory/tidkc.html) | Distribution-based Trajectory Clustering | Trajectory Clustering | ICDM2023 |

| Abbr | Algorithm | Application | Publication |
| ---------------------------------------------------------------------------- | --------------------------------------------------------------- | ---------------------------- | ----------- |
| [TIDKC](https://isolationkernel.github.io/ikpykit/latest/api/trajectory/tidkc.html) | Distribution-based Tajectory Clustering | Trajectory Clustering | ICDM2023 |
| [IKAT](https://isolationkernel.github.io/ikpykit/latest/api/trajectory/ikat.html) | Isolation Distribution Kernel for Trajectory Anomaly Detections | Trajectory Anomaly Detection | JAIR2024 |
**(viii) Time Series Mining**:

**(VIII) Time Series**
| Abbr | Algorithm | Application | Publication |
| --- | --- | --- | --- |
| [IKTOD](https://isolationkernel.github.io/ikpykit/latest/api/timeseries/iktod.html) | Isolation distribution kernel for Time Series Anomaly Detection | Anomaly Detection | VLDB2022 |

| Abbr | Algorithm | Application | Publication |
| ----------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------------- | ----------- |
| [IKTOD](https://isolationkernel.github.io/ikpykit/latest/api/time_series/iktod.html) | Isolation distribution kernel for Time Series Anomaly Detection | Anomaly detection | VLDB2022 |
<!-- END GENERATED ALGORITHMS -->

---

Expand Down
Loading
Loading