Skip to content

Commit 0696eb5

Browse files
xhochyxhochy
committed
ARROW-3932: [Python] Include Benchmarks.md in Sphinx docs
Author: Uwe L. Korn <uwelk@xhochy.com> Closes apache#3249 from xhochy/ARROW-3932 and squashes the following commits: 8e969c1 <Uwe L. Korn> Link to Sphinx documentation for benchmarks 06c3b8d <Uwe L. Korn> ARROW-3932: Include Benchmarks.md in Sphinx docs
1 parent 6781c2d commit 0696eb5

5 files changed

Lines changed: 57 additions & 76 deletions

File tree

‎docs/Benchmarks.md‎

Lines changed: 0 additions & 29 deletions
This file was deleted.

‎docs/source/python/benchmarks.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
.. Licensed to the Apache Software Foundation (ASF) under one
2+
.. or more contributor license agreements. See the NOTICE file
3+
.. distributed with this work for additional information
4+
.. regarding copyright ownership. The ASF licenses this file
5+
.. to you under the Apache License, Version 2.0 (the
6+
.. "License"); you may not use this file except in compliance
7+
.. with the License. You may obtain a copy of the License at
8+
9+
.. http://www.apache.org/licenses/LICENSE-2.0
10+
11+
.. Unless required by applicable law or agreed to in writing,
12+
.. software distributed under the License is distributed on an
13+
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
.. KIND, either express or implied. See the License for the
15+
.. specific language governing permissions and limitations
16+
.. under the License.
17+
18+
Benchmarks
19+
==========
20+
21+
The ``pyarrow`` package comes with a suite of benchmarks meant to
22+
run with `asv`_. You'll need to install the ``asv`` package first
23+
(``pip install asv`` or ``conda install -c conda-forge asv``).
24+
25+
The benchmarks are run using `asv`_ which is also their only requirement.
26+
27+
Running the benchmarks
28+
----------------------
29+
30+
To run the benchmarks, call ``asv run --python=same``. You cannot use the
31+
plain ``asv run`` command at the moment as asv cannot handle python packages
32+
in subdirectories of a repository.
33+
34+
Running with arbitrary revisions
35+
--------------------------------
36+
37+
ASV allows to store results and generate graphs of the benchmarks over
38+
the project's evolution. For this you have the latest development version of ASV:
39+
40+
.. code::
41+
42+
pip install git+https://github.com/airspeed-velocity/asv
43+
44+
Now you should be ready to run ``asv run`` or whatever other command
45+
suits your needs.
46+
47+
Compatibility
48+
-------------
49+
50+
We only expect the benchmarking setup to work with Python 3.6 or later,
51+
on a Unix-like system.
52+
53+
.. asv:: https://asv.readthedocs.org/

‎docs/source/python/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,4 @@ files into Arrow structures.
4747
api
4848
development
4949
getting_involved
50+
benchmarks

‎python/README-benchmarks.md‎

Lines changed: 0 additions & 47 deletions
This file was deleted.

‎python/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ pytest pyarrow --help
7676

7777
and look for the "custom options" section.
7878

79+
For running the benchmarks, see the [Sphinx documentation][5].
80+
7981
### Building the documentation
8082

8183
```bash
@@ -86,3 +88,4 @@ python setup.py build_sphinx -s ../docs/source
8688
[2]: https://github.com/apache/arrow/blob/master/docs/source/python/development.rst
8789
[3]: https://github.com/pandas-dev/pandas
8890
[4]: https://docs.pytest.org/en/latest/
91+
[5]: https://arrow.apache.org/docs/latest/python/benchmarks.html

0 commit comments

Comments
 (0)