Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yzhao062 authored and [email protected] committed Sep 3, 2018
1 parent 20e1ef4 commit 0c05585
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,18 @@
PyOD is a *comprehensive* and *efficient* **Python toolkit** to **identify outlying objects** in
multivariate data. This exciting yet challenging field is commonly referred as
***[Outlier Detection](https://en.wikipedia.org/wiki/Anomaly_detection)***
or ***[Anomaly Detection](https://en.wikipedia.org/wiki/Anomaly_detection)***
or ***[Anomaly Detection](https://en.wikipedia.org/wiki/Anomaly_detection)*** .Since 2017, PyOD has been successfully used in various academic researches [4, 8] and commercial products.
PyOD is featured for:

Since 2017, PyOD has been successfully used in various academic researches [4, 8] and commercial products.
Unlike existing libraries, PyOD provides:

- **Unified APIs** across various anomaly detection algorithms for easy use.
- **Advanced functions**, e.g., **Neural Networks/Deep Learning Models** and **Outlier Ensemble Frameworks**.
- **Unified APIs, detailed documentation and interactive examples** across various anomaly detection algorithms for short learning curve.
- **Advanced anomaly detection models**, e.g., **Neural Networks/Deep Learning** and **Outlier Ensembles**.
- **Optimized performance with JIT compilation and parallelization**, when the condition allows.
- **Compatibility with both Python 2 and 3**. All implemented algorithms are also **scikit-learn compatible**.
- **Detailed API Reference, Interactive Examples in Jupyter Notebooks** for better reliability.
- **Compatibility with both Python 2 & 3**. All implemented algorithms are also **scikit-learn compatible**.


**Table of Contents**:
<!-- TOC -->
- [Key Links & Resources](#key-links-and-resources)
- [Quick Introduction](#quick-introduction)
- [Installation](#installation)
- [API Cheatsheet & Reference](#api-cheatsheet--reference)
Expand All @@ -35,7 +34,8 @@ Unlike existing libraries, PyOD provides:
<!-- /TOC -->

------------------------------
# Key Links & Resources

### Key Links and Resources

- **[Documentation & API Reference](https://pyod.readthedocs.io)** [![Documentation Status](https://readthedocs.org/projects/pyod/badge/?version=latest)](https://pyod.readthedocs.io/en/latest/?badge=latest)

Expand Down
Binary file modified examples/KNN.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0c05585

Please sign in to comment.