https://github.com/isolationkernel/ikpykit
IKPyKit: Isolation Kernel Python toolKit
https://github.com/isolationkernel/ikpykit
anomaly-detection clustering data-science graph-mining isolation-kernel kernel-methods machine-learning scikit-learn stream-mining time-series
Last synced: 10 months ago
JSON representation
IKPyKit: Isolation Kernel Python toolKit
- Host: GitHub
- URL: https://github.com/isolationkernel/ikpykit
- Owner: IsolationKernel
- License: other
- Created: 2024-06-14T07:16:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-10T12:56:44.000Z (11 months ago)
- Last Synced: 2025-04-13T04:13:01.868Z (10 months ago)
- Topics: anomaly-detection, clustering, data-science, graph-mining, isolation-kernel, kernel-methods, machine-learning, scikit-learn, stream-mining, time-series
- Language: Python
- Homepage: https://isolationkernel.github.io/ikpykit/
- Size: 43.9 MB
- Stars: 5
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing/contribution.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pypi.org/project/ikpykit/)
[](https://codecov.io/gh/IsolationKernel/ikpykit)
[](https://github.com/IsolationKernel/ikpykit/actions/workflows/python-app.yml/badge.svg)
[](https://www.repostatus.org/#active)
[](https://github.com/IsolationKernel/ikpykit/graphs/commit-activity)
[](https://pepy.tech/project/ikpykit)
[](https://pepy.tech/project/ikpykit)
[](https://github.com/IsolationKernel/ikpykit/blob/master/LICENSE)
## About The Project
**IKPyKit** (Isolation Kernel Python toolKit) is an intuitive Python library designed for a variety of machine learning tasks including kernel similarity calculation, anomaly detection, clustering, and change detection—all powered by the innovative **Isolation Kernel (IK)** . Isolation Kernel is a data-dependent kernel that measures similarity by isolating data points using an isolation mechanism. It uniquely adapts to the data distribution, with the property that points in sparse regions are more similar than those in dense regions. Notably, it requires no learning or closed-form expression, making it efficient and scalable.
---
### Why use Isolation Kernel?
- **Data-Dependent Similarity**: Unlike traditional kernels (e.g., Gaussian, Laplacian), Isolation Kernel adapts to the structure of the data rather than assuming a fixed similarity function.
- **Handles Sparse and Dense Regions**: Isolation Kernel effectively accounts for varying data densities, making it ideal for datasets with non-uniform distributions.
- **No Learning Required**: It eliminates the need for training or parameter tuning, simplifying implementation while reducing computational cost.
- **Effective in High Dimensions**: It uniquely addresses the curse of dimensionality, being the only known measure capable of finding exact nearest neighbors in high-dimensional spaces.
- **Versatile Applications**: Isolation Kernel has been successfully applied to tasks like anomaly detection, clustering, and processing stream data, graph data, trajectory data, and more.
Learn more about its history and development on the [IsolationKernel GitHub page](https://github.com/IsolationKernel).
---
### Why use IKPyKit?
IKPyKit is specifically built to harness the power of Isolation Kernel, providing specialized algorithms for a wide range of data types and tasks. Its seamless integration with the scikit-learn API allows easy adoption and compatibility with scikit-learn tools.
- **Tailored for Isolation Kernel**: IKPyKit directly leverages the unique properties of Isolation Kernel for efficient and effective machine learning solutions.
- **Efficient and User-Friendly**: Designed for simplicity and performance, IKPyKit offers an intuitive interface built on the scikit-learn API.
- **Support for Diverse Data Types**: It supports graph data, group data, stream data, time series, and trajectory data, making it versatile for various domains.
- **Comprehensive Resources**: Users benefit from rich documentation and examples to quickly understand and apply the library’s features.
- **Ideal for Research and Industry**: IKPyKit is suitable for both academic research and industrial applications, providing scalable and cutting-edge tools for modern machine learning challenges.
---
## Installation & Dependencies
To install the basic version of `ikpykit` with core dependencies, run the following:
```bash
pip install ikpykit
```
For more installation options, including dependencies and additional features, check out our [Installation Guide](https://isolationkernel.github.io/ikpykit/quick-start/how-to-install.html).
---
## Example
```py
# Anomaly Detection using inne.
import numpy as np
from ikpykit.anomaly import INNE
X = np.array([[-1.1, 0.2], [0.3, 0.5], [0.5, 1.1], [100, 90]])
clf = INNE(contamination=0.25).fit(X)
clf.predict([[0.1, 0.3], [0, 0.7], [90, 85]])
```
---
## Implemented 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'22） | IKGAD （SIGKDD'22） | | |
| Stream Data | | | StreaKHC (SIGKDD'22) | ICID (JAIR'24) |
| Time Series | | IKTOD (VLDB'22) | | |
| Trajectory Data | | IKAT (JAIR'24) | TIDKC (ICDM'23) | |
**(i) Isolation Kernel** :
| Abbr | Algorithm | Utilization | Published |
| -------------------------------------------------------------------------------------------- | ----------------------------- | --------------------------------------------- | -------------------- |
| [IsoKernel](https://isolationkernel.github.io/ikpykit/api/kernel/isolation_kernel.html) | Isolation Kernel | IK feature mapping and similarity calculating | AAAI2019, SIGKDD2018 |
| [IsodisKernel](https://isolationkernel.github.io/ikpykit/api/kernel/isolation_dis_kernel.html) | Isolation Distribution Kernel | Distribution similarity calculating | SIGKDD2022 |
**(ii) Point Anomaly detection** :
| Abbr | Algorithm | Utiliztion | Published |
| --------------------------------------------------------------------------- | ------------------------------------------------------------------ | ----------------- | ------------------ |
| [IForest](https://isolationkernel.github.io/ikpykit/api/anomaly/iforest.html) | Isolation forest | Anomaly Detection | ICDM2008, TKDD2022 |
| [INNE](https://isolationkernel.github.io/ikpykit/api/anomaly/inne.html) | Isolation-based anomaly detection using nearest-neighbor ensembles | Anomaly Detection | CIJ2018 |
| [IDKD](https://isolationkernel.github.io/ikpykit/api/anomaly/idkd.html) | Isolation Distributional Kernel for point anomaly detections | Anomaly Detection | TKDE2022 |
**(iii) Point Clustering** :
| Abbr | Algorithm | Utiliztion | Published |
| ----------------------------------------------------------------------- | ------------------------------------------------------------ | ----------------------- | --------- |
| [IDKC](https://isolationkernel.github.io/ikpykit/api/cluster/idkc.html) | Kernel-based Clustering via Isolation Distributional Kernel. | Point Clustering | IS2023 |
| [PSKC](https://isolationkernel.github.io/ikpykit/api/cluster/pskc.html) | Point-set Kernel Clustering | Point Clustering | TKDE2023 |
| [IKAHC](https://isolationkernel.github.io/ikpykit/api/cluster/ikahc.html) | Isolation Kernel for Agglomerative Hierarchical Clustering | Hierarchical Clustering | PR2023 |
**(IV) Graph Data** :
| Abbr | Algorithm | Utiliztion | Published |
| --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | --------------------------------------------- | --------- |
| [IKGOD](https://isolationkernel.github.io/ikpykit/api/graph/ikgod.html) | Subgraph Centralization: A Necessary Step for Graph Anomaly Detection. | Graph Anomaly Detection | SIAM2023 |
| [IsoGraphKernel](https://isolationkernel.github.io/ikpykit/api/graph/IsoGraphKernel.html) | Isolation Graph Kernel | Graph IK embedding and similarity calculating | AAAI2021 |
**(V) Group Data** :
| Abbr | Algorithm | Utiliztion | Published |
| --------------------------------------------------------------------- | ------------------------------------------------------------ | ----------------------- | --------- |
| [IKGAD](https://isolationkernel.github.io/ikpykit/api/group/ikgad.html) | Isolation Distributional Kernel for group anomaly detections | Group Anomaly Detection | TKDE2022 |
**(VI) Stream Data** :
| Abbr | Algorithm | Utiliztion | Published |
| ---------------------------------------------------------------------------- | --------------------------------------------------------------- | ------------------------------ | ---------- |
| [StreaKHC](https://isolationkernel.github.io/ikpykit/api/stream/streakhc.html) | Isolation Distribution Kernel for Trajectory Anomaly Detections | Online Hierarchical Clustering | SIGKDD2022 |
| [ICID](https://isolationkernel.github.io/ikpykit/api/stream/icid.html) | Detecting change intervals with isolation distributional kernel | Change Intervals Detection | JAIR2024 |
**(VII) Trajectory Data** :
| Abbr | Algorithm | Utiliztion | Published |
| -------------------------------------------------------------------------- | --------------------------------------------------------------- | ---------------------------- | --------- |
| [TIDKC](https://isolationkernel.github.io/ikpykit/api/trajectory/tidkc.html) | Distribution-based Tajectory Clustering | Trajectory Clustering | ICDM2023 |
| [IKAT](https://isolationkernel.github.io/ikpykit/api/trajectory/ikat.html) | Isolation Distribution Kernel for Trajectory Anomaly Detections | Trajectory Anomaly Detection | JAIR2024 |
**(VIII) Time Series**
| Abbr | Algorithm | Utiliztion | Published |
| --------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------------- | --------- |
| [IKTOD](https://isolationkernel.github.io/ikpykit/api/time_series/iktod.html) | Isolation distribution kernel for Time Series Anomaly Detection | Anomaly detection | VLDB2022 |
---
## Features
IKPyKit provides a set of key features designed to make machine learning tasks easy and efficient. For a detailed overview, see the [User Guides](https://isolationkernel.github.io/ikpykit/user_guides/table-of-contents.html).
---
## Examples and tutorials
Explore our extensive list of examples and tutorials to get you started with IKPyKit. You can find them [here](https://isolationkernel.github.io/ikpykit/examples/examples_english.html).
---
## How to contribute
Primarily, IKPyKit development consists of adding and creating new algorithms, new validation strategies, or improving the performance of the current code. However, there are many other ways to contribute:
- Submit a bug report or feature request on [GitHub Issues](https://github.com/IsolationKernel/ikpykit/issues).
- Contribute a Jupyter notebook to our [examples](https://isolationkernel.github.io/ikpykit/examples/examples_english.html).
- Write [unit or integration tests](https://docs.pytest.org/en/latest/) for our project.
- Answer questions on our issues, Stack Overflow, and elsewhere.
- Translate our documentation into another language.
- Write a blog post, tweet, or share our project with others.
For more information on how to contribute to IKPyKit, see our [Contribution Guide](https://isolationkernel.github.io/ikpykit/contributing/contribution.html).
Visit our [authors section](https://isolationkernel.github.io/ikpykit/authors/authors.html) to meet all the contributors to IKPyKit.
---
## Citation
If you use IKPyKit for a scientific publication, we would appreciate citations to the published software.
**BibTeX**:
```
@software{IKPyKit,
author = {Xin Han, Yixiao Ma, Ye Zhu, and Kaiming Ting},
title = {IKPyKit：A Python Library for Isolation Kernel Toolkit},
version = {0.1.0},
month = {3},
year = {2025},
license = {BSD-3-Clause},
url = {https://github.com/IsolationKernel/ikpykit}
}
```
---
## License
[BSD-3-Clause License](https://github.com/IsolationKernel/ikpykit/blob/master/LICENSE)