mirror of
https://github.com/apache/arrow.git
synced 2026-10-29 00:56:31 +08:00
ARROW-3932: [Python] Include Benchmarks.md in Sphinx docs
This commit is contained in:
Uwe L. Korn committed
1 parent
48dd1724dd
commit
06c3b8d054
4 files changed
+54
-76
No files matched your search
@@ -1,29 +0,0 @@
|
||||
<!---
|
||||
Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
## Benchmark Requirements
|
||||
|
||||
The benchmarks are run using [asv][1] which is also their only requirement.
|
||||
|
||||
## Running the benchmarks
|
||||
|
||||
To run the benchmarks, call `asv run --python=same`. You cannot use the
|
||||
plain `asv run` command at the moment as asv cannot handle python packages
|
||||
in subdirectories of a repository.
|
||||
|
||||
[1]: https://asv.readthedocs.org/
|
||||
@@ -0,0 +1,53 @@
|
||||
.. Licensed to the Apache Software Foundation (ASF) under one
|
||||
.. or more contributor license agreements. See the NOTICE file
|
||||
.. distributed with this work for additional information
|
||||
.. regarding copyright ownership. The ASF licenses this file
|
||||
.. to you under the Apache License, Version 2.0 (the
|
||||
.. "License"); you may not use this file except in compliance
|
||||
.. with the License. You may obtain a copy of the License at
|
||||
|
||||
.. http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
.. Unless required by applicable law or agreed to in writing,
|
||||
.. software distributed under the License is distributed on an
|
||||
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
.. KIND, either express or implied. See the License for the
|
||||
.. specific language governing permissions and limitations
|
||||
.. under the License.
|
||||
|
||||
Benchmarks
|
||||
==========
|
||||
|
||||
The ``pyarrow`` package comes with a suite of benchmarks meant to
|
||||
run with `asv`_. You'll need to install the ``asv`` package first
|
||||
(``pip install asv`` or ``conda install -c conda-forge asv``).
|
||||
|
||||
The benchmarks are run using `asv`_ which is also their only requirement.
|
||||
|
||||
Running the benchmarks
|
||||
----------------------
|
||||
|
||||
To run the benchmarks, call ``asv run --python=same``. You cannot use the
|
||||
plain ``asv run`` command at the moment as asv cannot handle python packages
|
||||
in subdirectories of a repository.
|
||||
|
||||
Running with arbitrary revisions
|
||||
--------------------------------
|
||||
|
||||
ASV allows to store results and generate graphs of the benchmarks over
|
||||
the project's evolution. For this you have the latest development version of ASV:
|
||||
|
||||
.. code::
|
||||
|
||||
pip install git+https://github.com/airspeed-velocity/asv
|
||||
|
||||
Now you should be ready to run ``asv run`` or whatever other command
|
||||
suits your needs.
|
||||
|
||||
Compatibility
|
||||
-------------
|
||||
|
||||
We only expect the benchmarking setup to work with Python 3.6 or later,
|
||||
on a Unix-like system.
|
||||
|
||||
.. asv:: https://asv.readthedocs.org/
|
||||
@@ -47,3 +47,4 @@ files into Arrow structures.
|
||||
api
|
||||
development
|
||||
getting_involved
|
||||
benchmarks
|
||||
@@ -1,47 +0,0 @@
|
||||
<!---
|
||||
Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
# Benchmarks
|
||||
|
||||
The `pyarrow` package comes with a suite of benchmarks meant to
|
||||
run with [ASV](https://asv.readthedocs.io). You'll need to install
|
||||
the `asv` package first (`pip install asv`).
|
||||
|
||||
## Running with your local tree
|
||||
|
||||
When developing, the simplest and fastest way to run the benchmark suite
|
||||
against your local changes is to use the `asv dev` command. This will
|
||||
use your current Python interpreter and environment.
|
||||
|
||||
## Running with arbitrary revisions
|
||||
|
||||
ASV allows to store results and generate graphs of the benchmarks over
|
||||
the project's evolution. For this you have the latest development version of ASV:
|
||||
|
||||
```shell
|
||||
pip install git+https://github.com/airspeed-velocity/asv
|
||||
```
|
||||
|
||||
Now you should be ready to run `asv run` or whatever other command
|
||||
suits your needs.
|
||||
|
||||
## Compatibility
|
||||
|
||||
We only expect the benchmarking setup to work with Python 3.6 or later,
|
||||
on a Unix-like system.
|
||||
Reference in new issue
Block a user