Skip to content

Lightning fast OLAP-style point queries on Pandas DataFrames.

License

Notifications You must be signed in to change notification settings

nanocubeai/nanocube

Repository files navigation

NanoCube

Lightning fast OLAP-style point queries on DataFrames.

GitHub license PyPI version PyPI Downloads GitHub last commit unit tests


Info: NanoCube is under active development and subject to change. This current version, although working nicely, should be seen as a first proof of concept.

NanoCube is a minimalistic in-memory, in-process OLAP engine for lightning fast point queries on Pandas DataFrames. NanoCube shines when filtering and/or point queries need to be executed on a DataFrame, e.g. for financial data analysis, business intelligence or fast web services.

If you think it would be valuable to extend NanoCube with additional OLAP features please let me know. You can reach out by opening an issue or contacting me on LinkedIn.

pip install nanocube
import pandas as pd
from nanocube import NanoCube

# create a DataFrame
df = pd.read_csv('sale_data.csv')
value = df.loc[(df['make'].isin(['Audi', 'BMW']) & (df['engine'] == 'hybrid')]['revenue'].sum()

# create a NanoCube and run sum aggregated point queries
# Declare the column supposed to be aggregated in `measures` and filtered in `dimensions`
nc = NanoCube(df, dimensions=["make", "engine"], measures=["revenue"])
for i in range(1000):
    value = nc.get('revenue', make=['Audi', 'BMW'], engine='hybrid')

Lightning fast - really?

Aggregated point queries with NanoCube are often 100x to 1,000x times faster than using Pandas. The more selective the query, the more you benefit from NanoCube. For highly selective queries, NanoCube can even be 10,000x times faster than Pandas. For non-selective queries, the performance is 10x faster and finally similar to Pandas, as both rely on Numpy for aggregation. NanoCube only accelerates the filtering of data, not the aggregation.

For the special purpose of aggregative point queries, NanoCube is even faster than other DataFrame related technologies, like Spark, Polars, Modin, Dask or Vaex. If such libraries are a drop-in replacements for Pandas, then you should be able to speed up their filtering quite noticeably. Try it and let me know how it performs.

NanoCube is beneficial only if some point queries (> 5) need to be executed, as the initialization time for the NanoCube needs to be taken into consideration. The more point query you run, the more you benefit from NanoCube.

Benchmark - NanoCube vs. Others

The following table shows the duration for 1000x point queries on the car_prices_us dataset (available on kaggle.com) containing 16x columns and 558,837x rows. The query is highly selective, filtering on 4 dimensions (model='Optima', trim='LX', make='Kia', body='Sedan') and aggregating column mmr. The factor is the speedup of NanoCube vs. the respective technology.

To reproduce the benchmark, you can execute file nano_vs_others.py.

technology duration_sec factor
0 NanoCube 0.016 1
1 SQLite (indexed) 0.133 8.312
2 Polars 0.534 33.375
3 Arrow 1.933 120.812
4 DuckDB 4.171 260.688
5 SQLite 12.452 778.25
6 Pandas 36.457 2278.56

How is this possible?

NanoCube creates an in-memory multi-dimensional index over all relevant entities/columns in a dataframe. Internally, Roaring Bitmaps (https://roaringbitmap.org) are used by default for representing the index. Initialization may take some time, but yields very fast filtering and point queries. As an alternative to Roaring Bitmaps, Numpy-based indexing can be used. These are faster if only one filter is applied, but can be orders of magnitude slower if multiple filters are applied.

Approach: For each unique value in all relevant dimension columns, a bitmap is created that represents the rows in the DataFrame where this value occurs. The bitmaps can then be combined or intersected to determine the rows relevant for a specific filter or point query. Once the relevant rows are determined, Numpy is used then for to aggregate the requested measures.

NanoCube is a by-product of the CubedPandas project (https://github.com/Zeutschler/cubedpandas) and will be integrated into CubedPandas in the future. But for now, NanoCube is a standalone library that can be used with any Pandas DataFrame for the special purpose of point queries.

Tips for using NanoCube

Tip: Only include those columns in the NanoCube setup, that you actually want to query! The more columns you include, the more memory and time is needed for initialization.

df = pd.read_csv('dataframe_with_100_columns.csv')
nc = NanoCube(df, dimensions=['col1', 'col2'], measures=['col100'])

Tip: If you have a DataFrame with more than 1 million rows, you may want to sort the DataFrame before creating the NanoCube. This can improve the performance of NanoCube significantly, upto 10x times.

Tip: NanoCubes can be saved and loaded to/from disk. This can be useful if you want to reuse a NanoCube for multiple queries or if you want to share a NanoCube with others. NanoCubes are saved in Arrow format but load up to 4x times faster than the respective parquet DataFrame file.

nc = NanoCube(df, dimensions=['col1', 'col2'], measures=['col100'])
nc.save('nanocube.nc')
nc_reloaded = NanoCube.load('nanocube.nc')
> ```

What price do I have to pay?

NanoCube is free and MIT licensed. The prices to pay are additional memory consumption, depending on the use case typically 25% on top of the original DataFrame and the time needed for initializing the multi-dimensional index, typically 250k rows/sec depending on the number of columns to be indexed and your hardware. The initialization time is proportional to the number of rows in the DataFrame (see below).

You may want to try and adapt the included samples sample.py and benchmarks benchmark.py and benchmark.ipynb to test the behavior of NanoCube on your data.

NanoCube Benchmarks

Using the Python script benchmark_all.py, the following comparison charts can be created. The datasets are made of random data with 2 numerical columns and 7 categorical columns with different cardinalities ranging from 2 up to the number of rows. The dataset starts at just 100 rows and then the size is doubled until >10M rows are reached. For further details, see the benchmark_all.py script.

CAUTION: Benchmarks should be taken with a grain of salt. These tests were run on a 16-core Apple Silicon M4 Max MacBook Pro; results may vary significantly on Windows or Linux machines. They focus on fast filtering and aggregate point queries, not joins, groupbys, or other SQL operations. Despite this, the benchmarks provide a good indication of NanoCube’s performance relative to other DataFrame technologies. Enjoy...

Let's see how CubePandas performs on different types of aggregative point queries against the famous competitors (in alphatecical order). All engine are used in-memory only and have been called from Python:

  • PyArrow link - Apache Arrow is a development platform for in-memory analytics. It contains a set of technologies that enable big data systems to store, process and move data fast.
  • DuckDB link - DuckDB is a fast in-process analytical database system. DuckDB supports a feature-rich SQL dialect complemented with deep integrations into client APIs.
  • NanoCube (Roaring Index) - Just a few lines of single-threaded Python code.
  • NanoCube (Numpy Index) - NanoCube is a minimalistic in-memory, in-process OLAP engine for lightning fast point queries writen in Python.
  • Pandas link - NanoCube this time uses a different index, based on Numpy arrays instead of Roaring Bitmaps.
  • Polars link - Polars is a blazingly fast DataFrame library implemented in Rust and built on top of Apache Arrow.
  • SQLite link - SQLite is a C-language library that implements a small, fast, self-contained, high-reliability, full-featured, SQL database engine.
  • SQLite fully indexed link - SQLite is now indexed on all categorical columns of the dataset.

Let's take a look at different types of queries and how NanoCube performs in comparison to the competitors.

Point query for a single row

A highly selective query, fully qualified and filtering over all 7 dimensions. The query will return and aggregates 1 single row. NanoCube is faster than competitors, for larger datasets up to 10,000x times than Pandas. Polars is really super-fast, though still 100x slower on such very selective queries. Interestingly, SQLite fully indexed can't make much profit from all the indexes. As always, Pandas, although beeing the most popular dataframe engine, is the slowest on increasingly large datasets.

Point query for single row

Point query on high cardinality column

A highly selective, filtering on a single high cardinality dimension, where each member represents ±0.01% of the dataset. Also here, I would have expected SQLite fully indexed to be faster (query on a single fully index column), but it is not. The pyArrow library is a bit disappointing. Polars is again super-fast.

Query on single high cardinality column

Point query aggregating 0.1% of rows

A highly selective, filtering on 1 dimension that affects and aggregates 0.1% of the dataset, e.g. if we have 1M rows, then 1,000 rows are affected and aggregated.

Point query aggregating 0.1% of rows

Point query aggregating 5% of rows

A barely selective, filtering on 2 dimensions that affects and aggregates 5% of rows. At this size of query results, the time spent in for numerical aggregation becomes more dominant. At this size, both DuckDB and Polars shine. Very interestingly the fully indexed SQLite is slowest, even slower than the unindexed SQLite database. no clue why

Point query aggregating 5% of rows

If sorting is applied to the DataFrame - low cardinality dimension columns first, higher dimension cardinality columns last - then the performance of NanoCube can potentially improve dramatically, ranging from not faster up to ±10x or more times faster. Here, the same query as above, but the DataFrame was sorted over all columns beforehand. The reason is that both, Roaring Bitmaps index and the Numpy index, now benefit from better cache locality and less memory fragmentation due to sequential access to memory.

Point query for single row

Point query aggregating 50% of rows

A non-selective query, filtering on 1 dimension that affects and aggregates 50% of rows. Here, most of the time is spent on aggregating values. As NanoCube is just single-threaded interpreted Python code, it can't keep up with the multithreaded power houses Polars and especially DuckDB. When it comes to mass data processing and aggregation, DuckDB is likely the current best technology out there.

Point query aggregating 50% of rows

NanoCube initialization time

The time required to initialize a NanoCube instance is almost linear. The initialization throughput heavily depends on the number of dimension columns. A custom file format will be added soon allowing ±4x times faster loading of a NanoCube in comparison to loading the respective parquet dataframe file using Arrow.

NanoCube initialization time

About

Lightning fast OLAP-style point queries on Pandas DataFrames.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages