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 13, 2019
1 parent a7aa076 commit c0a2144
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -291,15 +291,15 @@ Algorithm Benchmark
(\ `Figure <https://raw.githubusercontent.com/yzhao062/pyod/master/examples/ALL.png>`_\ ,
`compare_all_models.py <https://github.com/yzhao062/pyod/blob/master/examples/compare_all_models.py>`_\ ,
`Interactive Jupyter Notebooks <https://mybinder.org/v2/gh/yzhao062/pyod/master>`_\ ).
For Jupyter Notebooks, please navigate to **"/notebooks/Compare All Models.ipynb"**
For Jupyter Notebooks, please navigate to **"/notebooks/Compare All Models.ipynb"**.


.. image:: https://raw.githubusercontent.com/yzhao062/pyod/master/examples/ALL.png
:target: https://raw.githubusercontent.com/yzhao062/pyod/master/examples/ALL.png
:alt: Comparision_of_All

To provide an overview of the implemented models, a benchmark
is supplied for select algorithms. In total, 17 benchmark data are used for comparision which
is supplied for select algorithms. In total, 17 benchmark data are used for comparision, which
can 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.
Expand All @@ -311,7 +311,7 @@ are provided:
- Precision @ rank n (P@N)
- Execution time

Check the latest result `benchmark <https://pyod.readthedocs.io/en/latest/benchmark.html>`_.
Check the latest `benchmark <https://pyod.readthedocs.io/en/latest/benchmark.html>`_.
You are welcome to replicate this process by running
`benchmark.py <https://github.com/yzhao062/pyod/blob/master/notebooks/benchmark.py>`_.

Expand Down
2 changes: 1 addition & 1 deletion docs/benchmark.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Introduction
------------

To provide an overview of the implemented models, a benchmark
is supplied for select algorithms. In total, 17 benchmark data are used for comparision which
is supplied for select algorithms. In total, 17 benchmark data are used for comparision, which
can 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.
Expand Down
9 changes: 7 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -201,11 +201,16 @@ Utility :func:`pyod.utils.utility.precision_n_scores` calculate pr
(\ `Figure <https://raw.githubusercontent.com/yzhao062/pyod/master/examples/ALL.png>`_\ ,
`compare_all_models.py <https://github.com/yzhao062/pyod/blob/master/examples/compare_all_models.py>`_\ ,
`Interactive Jupyter Notebooks <https://mybinder.org/v2/gh/yzhao062/pyod/master>`_\ ).
For Jupyter Notebooks, please navigate to **"/notebooks/Compare All Models.ipynb"**
For Jupyter Notebooks, please navigate to **"/notebooks/Compare All Models.ipynb"**.


.. figure:: figs/ALL.png
:alt: Comparison of all implemented models
:alt: Comparison of selected models

Check the latest `benchmark <https://pyod.readthedocs.io/en/latest/benchmark.html>`_.
You are welcome to replicate this process by running
`benchmark.py <https://github.com/yzhao062/pyod/blob/master/notebooks/benchmark.py>`_.


Key APIs & Attributes
=====================
Expand Down

0 comments on commit c0a2144

Please sign in to comment.