You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by uw...@apache.org on 2018/12/27 17:11:39 UTC
[arrow] branch master updated: ARROW-3932: [Python] Include
Benchmarks.md in Sphinx docs
This is an automated email from the ASF dual-hosted git repository.
uwe pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new 0696eb5 ARROW-3932: [Python] Include Benchmarks.md in Sphinx docs
0696eb5 is described below
commit 0696eb591f4707377067b53ecdc9be1dbc4c6a34
Author: Uwe L. Korn <uw...@xhochy.com>
AuthorDate: Thu Dec 27 18:11:30 2018 +0100
ARROW-3932: [Python] Include Benchmarks.md in Sphinx docs
Author: Uwe L. Korn <uw...@xhochy.com>
Closes #3249 from xhochy/ARROW-3932 and squashes the following commits:
8e969c1b <Uwe L. Korn> Link to Sphinx documentation for benchmarks
06c3b8d0 <Uwe L. Korn> ARROW-3932: Include Benchmarks.md in Sphinx docs
---
docs/Benchmarks.md | 29 ---------------------
docs/source/python/benchmarks.rst | 53 +++++++++++++++++++++++++++++++++++++++
docs/source/python/index.rst | 1 +
python/README-benchmarks.md | 47 ----------------------------------
python/README.md | 3 +++
5 files changed, 57 insertions(+), 76 deletions(-)
diff --git a/docs/Benchmarks.md b/docs/Benchmarks.md
deleted file mode 100644
index c84bf0d..0000000
--- a/docs/Benchmarks.md
+++ /dev/null
@@ -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/
diff --git a/docs/source/python/benchmarks.rst b/docs/source/python/benchmarks.rst
new file mode 100644
index 0000000..6c3144a
--- /dev/null
+++ b/docs/source/python/benchmarks.rst
@@ -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/
diff --git a/docs/source/python/index.rst b/docs/source/python/index.rst
index cf691e3..fe04a73 100644
--- a/docs/source/python/index.rst
+++ b/docs/source/python/index.rst
@@ -47,3 +47,4 @@ files into Arrow structures.
api
development
getting_involved
+ benchmarks
diff --git a/python/README-benchmarks.md b/python/README-benchmarks.md
deleted file mode 100644
index 77901f3..0000000
--- a/python/README-benchmarks.md
+++ /dev/null
@@ -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.
diff --git a/python/README.md b/python/README.md
index ce69693..ce7bdde 100644
--- a/python/README.md
+++ b/python/README.md
@@ -76,6 +76,8 @@ pytest pyarrow --help
and look for the "custom options" section.
+For running the benchmarks, see the [Sphinx documentation][5].
+
### Building the documentation
```bash
@@ -86,3 +88,4 @@ python setup.py build_sphinx -s ../docs/source
[2]: https://github.com/apache/arrow/blob/master/docs/source/python/development.rst
[3]: https://github.com/pandas-dev/pandas
[4]: https://docs.pytest.org/en/latest/
+[5]: https://arrow.apache.org/docs/latest/python/benchmarks.html