Array Programming with Numpy
Total Page:16
File Type:pdf, Size:1020Kb
Review Array programming with NumPy https://doi.org/10.1038/s41586-020-2649-2 Charles R. Harris1, K. Jarrod Millman2,3,4 ✉, Stéfan J. van der Walt2,4,5 ✉, Ralf Gommers6 ✉, Pauli Virtanen7,8, David Cournapeau9, Eric Wieser10, Julian Taylor11, Sebastian Berg4, Received: 21 February 2020 Nathaniel J. Smith12, Robert Kern13, Matti Picus4, Stephan Hoyer14, Marten H. van Kerkwijk15, Accepted: 17 June 2020 Matthew Brett2,16, Allan Haldane17, Jaime Fernández del Río18, Mark Wiebe19,20, Pearu Peterson6,21,22, Pierre Gérard-Marchant23,24, Kevin Sheppard25, Tyler Reddy26, Published online: 16 September 2020 Warren Weckesser4, Hameer Abbasi6, Christoph Gohlke27 & Travis E. Oliphant6 Open access Check for updates Array programming provides a powerful, compact and expressive syntax for accessing, manipulating and operating on data in vectors, matrices and higher-dimensional arrays. NumPy is the primary array programming library for the Python language. It has an essential role in research analysis pipelines in felds as diverse as physics, chemistry, astronomy, geoscience, biology, psychology, materials science, engineering, fnance and economics. For example, in astronomy, NumPy was an important part of the software stack used in the discovery of gravitational waves1 and in the frst imaging of a black hole2. Here we review how a few fundamental array concepts lead to a simple and powerful programming paradigm for organizing, exploring and analysing scientifc data. NumPy is the foundation upon which the scientifc Python ecosystem is constructed. It is so pervasive that several projects, targeting audiences with specialized needs, have developed their own NumPy-like interfaces and array objects. Owing to its central position in the ecosystem, NumPy increasingly acts as an interoperability layer between such array computation libraries and, together with its application programming interface (API), provides a fexible framework to support the next decade of scientifc and industrial analysis. Two Python array packages existed before NumPy. The Numeric pack- that operate on it. Because of its inherent simplicity, the NumPy array age was developed in the mid-1990s and provided array objects and is the de facto exchange format for array data in Python. array-aware functions in Python. It was written in C and linked to stand- NumPy operates on in-memory arrays using the central processing ard fast implementations of linear algebra3,4. One of its earliest uses was unit (CPU). To utilize modern, specialized storage and hardware, there to steer C++ applications for inertial confinement fusion research at has been a recent proliferation of Python array packages. Unlike with Lawrence Livermore National Laboratory5. To handle large astronomi- the Numarray–Numeric divide, it is now much harder for these new cal images coming from the Hubble Space Telescope, a reimplementa- libraries to fracture the user community—given how much work is tion of Numeric, called Numarray, added support for structured arrays, already built on top of NumPy. However, to provide the community with flexible indexing, memory mapping, byte-order variants, more efficient access to new and exploratory technologies, NumPy is transitioning memory use, flexible IEEE 754-standard error-handling capabilities, and into a central coordinating mechanism that specifies a well defined better type-casting rules6. Although Numarray was highly compatible array programming API and dispatches it, as appropriate, to special- with Numeric, the two packages had enough differences that it divided ized array implementations. the community; however, in 2005 NumPy emerged as a ‘best of both worlds’ unification7—combining the features of Numarray with the small-array performance of Numeric and its rich C API. NumPy arrays Now, 15 years later, NumPy underpins almost every Python library The NumPy array is a data structure that efficiently stores and accesses that does scientific or numerical computation8–11, including SciPy12, multidimensional arrays17 (also known as tensors), and enables a wide Matplotlib13, pandas14, scikit-learn15 and scikit-image16. NumPy is a variety of scientific computation. It consists of a pointer to memory, community-developed, open-source library, which provides a mul- along with metadata used to interpret the data stored there, notably tidimensional Python array object along with array-aware functions ‘data type’, ‘shape’ and ‘strides’ (Fig. 1a). 1Independent researcher, Logan, UT, USA. 2Brain Imaging Center, University of California, Berkeley, Berkeley, CA, USA. 3Division of Biostatistics, University of California, Berkeley, Berkeley, CA, USA. 4Berkeley Institute for Data Science, University of California, Berkeley, Berkeley, CA, USA. 5Applied Mathematics, Stellenbosch University, Stellenbosch, South Africa. 6Quansight, Austin, TX, USA. 7Department of Physics, University of Jyväskylä, Jyväskylä, Finland. 8Nanoscience Center, University of Jyväskylä, Jyväskylä, Finland. 9Mercari JP, Tokyo, Japan. 10Department of Engineering, University of Cambridge, Cambridge, UK. 11Independent researcher, Karlsruhe, Germany. 12Independent researcher, Berkeley, CA, USA. 13Enthought, Austin, TX, USA. 14Google Research, Mountain View, CA, USA. 15Department of Astronomy and Astrophysics, University of Toronto, Toronto, Ontario, Canada. 16School of Psychology, University of Birmingham, Edgbaston, Birmingham, UK. 17Department of Physics, Temple University, Philadelphia, PA, USA. 18Google, Zurich, Switzerland. 19Department of Physics and Astronomy, The University of British Columbia, Vancouver, British Columbia, Canada. 20Amazon, Seattle, WA, USA. 21Independent researcher, Saue, Estonia. 22Department of Mechanics and Applied Mathematics, Institute of Cybernetics at Tallinn Technical University, Tallinn, Estonia. 23Department of Biological and Agricultural Engineering, University of Georgia, Athens, GA, USA. 24France-IX Services, Paris, France. 25Department of Economics, University of Oxford, Oxford, UK. 26CCS-7, Los Alamos National Laboratory, Los Alamos, NM, USA. 27Laboratory for Fluorescence Dynamics, Biomedical Engineering Department, University of California, Irvine, Irvine, CA, USA. ✉e-mail: [email protected]; [email protected]; [email protected] Nature | Vol 585 | 17 September 2020 | 357 Review a Data structure d Vectorization g Example 0 1 2 data 0 1 2 3 4 5 6 7 8 9 10 11 0 1 1 1 1 2 In [1]: import numpy as np 3 4 5 data type 8-byte integer 3 4 1 1 4 5 x = 8 bytes 3 × 8 = 24 bytes + (4, 3) → In [2]: x = np.arange(12) 6 7 8 shape per element to jump one 6 7 1 1 7 8 9 10 11 strides (24, 8) row down 9 10 1 1 10 11 In [3]: x = x.reshape(4, 3) In [4]: x b Indexing (view) e Broadcasting Out[4]: array([[ 0, 1, 2], 0 1 2 0 1 2 0 1 2 0 0 [ 3, 4, 5], 3 4 5 3 4 5 with slices x[:,1:] → with slices x[:,::2]→ 3 3 6 [ 6, 7, 8], 6 78 6 7 8 with steps × → 6 6 12 [ 9, 10, 11]]) 9 10 11 9 10 11 Slices are start:end:step, 9 9 18 any of which can be left blank In [5]: np.mean(x, axis=0) Out[5]: array([4.5, 5.5, 6.5]) c Indexing (copy) f Reduction In [6]: x = x - np.mean(x, axis=0) x[1,2] → 5 with scalars x[x > 9] → 10 11 with masks 0 1 2 3 sum 3 4 5 axis 1 12 In [7]: x with arrays 6 7 8 21 Out[7]: x 0 1 , 1 2 → x[0,1],x[1,2] → 1 5 9 10 11 30 array([[-4.5, -4.5, -4.5], sum [-1.5, -1.5, -1.5], 1 1 0 1 1 1 0 4 3 with arrays x → x → axis 0 sum [ 1.5, 1.5, 1.5], 2 2 2 1 0 7 6 with broadcasting axis (0,1) , , 18 22 26 66 [ 4.5, 4.5, 4.5]]) Fig. 1 | The NumPy array incorporates several fundamental array concepts. before performing the lookup. d, Vectorization efficiently applies operations a, The NumPy array data structure and its associated metadata fields. to groups of elements. e, Broadcasting in the multiplication of two-dimensional b, Indexing an array with slices and steps. These operations return a ‘view’ of arrays. f, Reduction operations act along one or more axes. In this example, the original data. c, Indexing an array with masks, scalar coordinates or other an array is summed along select axes to produce a vector, or along two axes arrays, so that it returns a ‘copy’ of the original data. In the bottom example, an consecutively to produce a scalar. g, Example NumPy code, illustrating some of array is indexed with other arrays; this broadcasts the indexing arguments these concepts. The data type describes the nature of elements stored in an array. statistics and trigonometry (Fig. 1d). Vectorization—operating on An array has a single data type, and each element of an array occupies entire arrays rather than their individual elements—is essential to array the same number of bytes in memory. Examples of data types include programming. This means that operations that would take many tens real and complex numbers (of lower and higher precision), strings, of lines to express in languages such as C can often be implemented as timestamps and pointers to Python objects. a single, clear Python expression. This results in concise code and frees The shape of an array determines the number of elements along users to focus on the details of their analysis, while NumPy handles each axis, and the number of axes is the dimensionality of the array. looping over array elements near-optimally—for example, taking For example, a vector of numbers can be stored as a one-dimensional strides into consideration to best utilize the computer’s fast cache array of shape N, whereas colour videos are four-dimensional arrays memory. of shape (T, M, N, 3). When performing a vectorized operation (such as addition) on two Strides are necessary to interpret computer memory, which stores arrays with the same shape, it is clear what should happen. Through elements linearly, as multidimensional arrays. They describe the num- ‘broadcasting’ NumPy allows the dimensions to differ, and produces ber of bytes to move forward in memory to jump from row to row, col- results that appeal to intuition.