Skip to content

Commit

Permalink
Update benchmark documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yzhao062 committed Mar 12, 2019
1 parent ed70958 commit 8501f96
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 18 deletions.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ It is recommended to use **pip** for installation. Please make sure
pip install --upgrade pyod # or update if needed
pip install --pre pyod # or include pre-release version for new features
Alternatively, you could clone and run setup.py file (**NOT Recommended**)
Alternatively, you could clone and run setup.py file (**NOT Recommended**):

.. code-block:: bash
Expand Down Expand Up @@ -301,11 +301,11 @@ For Jupyter Notebooks, please navigate to **"/notebooks/Compare All Models.ipynb
:alt: Comparision_of_All

To provide an overview and quick guidance of the implemented models, a benchmark
is supplied. In total, 17 benchmark data are used for comparision, all datasets could be
downloaded at `ODDS <http://odds.cs.stonybrook.edu/#table1>`_.
is supplied for select algorithms. In total, 17 benchmark data are used for comparision,
all datasets could be downloaded at `ODDS <http://odds.cs.stonybrook.edu/#table1>`_.

For each dataset, it is first split into 60% for training and 40% for testing.
All experiments are repeated 20 times independently with different samplings.
All experiments are repeated 10 times independently with different samplings.
The mean of 20 trials are taken as the final result. Three evaluation metrics
are provided:

Expand Down
17 changes: 3 additions & 14 deletions docs/benchmark.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ Benchmarks
Introduction
------------

To provide an overview and guidance of the implemented models, benchmark
is supplied below.

In total, 16 benchmark data are used for comparision, all datasets could be
downloaded at `ODDS <http://odds.cs.stonybrook.edu/#table1>`_.
To provide an overview and quick guidance of the implemented models, a benchmark
is supplied for select algorithms. In total, 17 benchmark data are used for comparision,
all datasets could be downloaded at `ODDS <http://odds.cs.stonybrook.edu/#table1>`_.

For each dataset, it is first split into 60% for training and 40% for testing.
All experiments are repeated 10 times independently with different splits.
Expand All @@ -19,9 +17,6 @@ are provided:
- Precision @ rank n (P@N)
- Execution time

**Note**: LSCP is a combination framework. In this benchmark it is based on 5
LOF detector (n_neighbors=[10,...,50]), so it is only meaningful to compare
LSCP with LOF, instead of other detection algorithms.

You are welcome to replicate this process by running:
`benchmark.py <https://github.com/yzhao062/Pyod/blob/master/notebooks/benchmark.py>`_
Expand All @@ -48,9 +43,3 @@ Execution Time
:file: tables/time.csv
:header-rows: 1

Conclusion
----------

TO ADD


0 comments on commit 8501f96

Please sign in to comment.