Skip to content

Commit

Permalink
Remove old benchmark documentation and add a new one to close #108.
Browse files Browse the repository at this point in the history
  • Loading branch information
TkTech committed Sep 3, 2023
1 parent eb88e67 commit 60b9235
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
20 changes: 12 additions & 8 deletions docs/contrib/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,8 @@ dependencies, use:
pip install -e ".[test]"
To also install 3rd party JSON libraries used for running benchmarks, use:

.. code::
pip install -e ".[benchmark]"
To run the tests, just type ``pytest``. To also run the benchmarks, use
``pytest --runslow``. ``--runslow`` will also run the NumPy integration tests.
To run the tests, just type ``pytest``. To also run some slow integration
tests, use ``pytest --runslow``.

To properly test builds on Windows, you need both a recent version of Visual
Studio as well as VS2015, patch 3. Older versions of CPython required portable
Expand Down Expand Up @@ -51,6 +45,16 @@ once, so to force Cython to rebuild it, use ``FORCE_REBUILD``:
BUILD_WITH_CYTHON=1 FORCE_REBUILD=1 python setup.py develop
Benchmarks
----------

The benchmarks that used to exist in this project have been moved into a
sister project, `json_benchmark`_. This project contains a number of
benchmarks for various JSON libraries, including pysimdjson. It also tests
for correctness, so it can be used to verify that simdjson is working
correctly.

.. _Developer Command Prompt: https://docs.microsoft.com/en-us/dotnet/
framework/tools/developer-command-prompt-for-vs
.. _Cython: https://cython.readthedocs.io/en/latest/
.. _json_benchmark: https://github.com/tktech/json_benchmark
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@
'pytest',
'pytest-benchmark',
'flake8',
'coverage'
'coverage',
'numpy'
]
},
ext_modules=extensions,
Expand Down

0 comments on commit 60b9235

Please sign in to comment.