A NumPy extension that allows arrays to be indexed using labels
Project description
NumPy StringIndexed
NumPy StringIndexed is a NumPy extension that allows arrays to be indexed using descriptive string labels, rather than conventional zeroindexing. When a friendly matrix object is initialized, labels are assigned to each array index and each dimension, and they stick to the array after NumPystyle operations such as transposing, concatenating, and aggregating. This prevents Python programmers from having to keep track mentally of what each axis and each index represents, instead making each reference to the array in code naturally selfdocumenting.
NumPy StringIndexed is especially useful for applications like machine learning, scientific computing, and data science, where there is heavy use of multidimensional arrays.
The friendly matrix object is implemented as a lightweight wrapper around a NumPy ndarray
. It's easy to add to a new or existing project to make it easier to maintain code, and has negligible memory and performance overhead compared to the size of array (O(x + y + z) vs. O(xyz)).
Basic functionality
It's recommended to import NumPy StringIndexed idiomatically as fm
:
import friendly_matrix as fm
Labels are provided during object construction and can optionally be used in place of numerical indices for slicing and indexing.
The example below shows how to construct a friendly matrix containing an image with three color channels:
image = fm.ndarray(
numpy_ndarray_image, # np.ndarray with shape (3, 100, 100)
dim_names=['color_channel', 'top_to_bottom', 'left_to_right'],
color_channel=['R', 'G', 'B'])
The matrix can then be sliced like this:
# friendly matrix with shape (100, 100)
r_channel = image(color_channel='R')
# an integer
g_top_left_pixel_value = image('G', 0, 0)
# friendly matrix with shape (2, 100, 50)
br_channel_left_half = image(
color_channel=('B', 'R'),
left_to_right=range(image.dim_length('left_to_right') // 2))
Documentation
Full documentation can be found here. Below is a brief overview of Friendly Matrix functionality.
Matrix operations
Friendly matrix objects can be operated on just like NumPy ndarray
s with minimal overhead. The package contains separate implementations of most of the relevant NumPy ndarray
operations, taking advantage of labels. For example:
side_by_side = fm.concatenate((image1, image2), axis='left_to_right')
An optimized alternative is to perform labelless operations, by adding "_A"
(for "array") to the operation name:
side_by_side_arr = fm.concatenate_A((image1, image2), axis='left_to_right')
If it becomes important to optimize within a particular scope, it's recommended to shed labels before operating:
for image in huge_list:
image_processor(image.A)
Computing matrices
A friendly matrix is an ideal structure for storing and retrieving the results of computations over multiple variables. The compute_ndarray()
function executes computations over all values of the input arrays and stores them in a new Friendly Matrix ndarray
instance in a single step:
'''Collect samples from a variety of normal distributions'''
import numpy as np
n_samples_list = [1, 10, 100, 1000]
mean_list = list(range(21, 21))
var_list = [1E1, 1E0, 1E1, 1E2, 1E3]
results = fm.compute_ndarray(
['# Samples', 'Mean', 'Variance']
n_samples_list,
mean_list,
var_list,
normal_sampling_function,
dtype=np.float32)
# friendly matrices can be sliced using dicts
print(results({
'# Samples': 100,
'Mean': 0,
'Variance': 1,
}))
Formatting matrices
The formatted()
function displays a friendly matrix as a nested list. This is useful for displaying the labels and values of smaller matrices or slice results:
mean_0_results = results({
'# Samples': (1, 1000),
'Mean': 0,
'Variance': (10, 1, 0.1),
})
formatted = fm.formatted(
mean_0_results,
formatter=lambda n: round(n, 1))
print(formatted)
'''
Example output:
# Samples = 1:
Variance = 10:
2.2
Variance = 1:
0.9
Variance = 0.1:
0.1
# Samples = 1000:
Variance = 10:
0.2
Variance = 1:
0.0
Variance = 0.1:
0.0
'''
Installation
pip install numpystringindexed
NumPy StringIndexed is listed in PyPI and can be installed with pip
.
Prerequisites: NumPy StringIndexed 0.0.3 requires Python 3 and a compatible installation of the NumPy Python package.
Discussion and support
NumPy StringIndexed is available under the MIT License.
Project details
Release history Release notifications  RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for numpystringindexed0.0.3.tar.gz
Algorithm  Hash digest  

SHA256  9f6bcad4582b17a65eaec2f3f45c9e8fcbee3ec96f218307d7c8dab72e2f39e4 

MD5  b79012222ae85efdf9a1d2b0a002e27e 

BLAKE2b256  d84af06f3dd1b550de1dd65744bb7454bcf5e0e3c1f04f780dee0b0e97de3b96 
Hashes for numpy_string_indexed0.0.3py3noneany.whl
Algorithm  Hash digest  

SHA256  0561ec8c873f8d2d79c24a04e4084c7ce7cb2cfc884ae1fe340cf723750fa247 

MD5  a13a7e17ebf054dbe99514e411896aef 

BLAKE2b256  7d7508c13467510902c04277235f75ef92825251b1fc69fc1951528f715c8eb9 