numexpr 2.10.1__tar.gz → 2.10.2__tar.gz

{numexpr-2.10.1 → numexpr-2.10.2}/ANNOUNCE.rst

@@ -1,29 +1,28 @@
 =========================
-Announcing NumExpr 2.10.1
+Announcing NumExpr 2.10.2
 =========================
 
 Hi everyone,
 
-NumExpr 2.10.1 continues to establize the support for NumPy 2.0.0.
-Also, the default number of 'safe' threads has been upgraded to 16
-(instead of previous 8). Finally, preliminary support for Python 3.13;
-thanks to Karolina Surma.
+NumExpr 2.10.2 provides wheels for Python 2.13 for first time.
+Also, there is better support for CPUs that do not have a power
+of 2 number of cores.  Finally, numexpr is allowed to run with
+the multithreading package in Python.
 
 Project documentation is available at:
 
 http://numexpr.readthedocs.io/
 
-Changes from 2.9.0 to 2.10.0
-----------------------------
+Changes from 2.10.1 to 2.10.2
+-----------------------------
 
-* Support for NumPy 2.0.0.  This is still experimental, so please
-  report any issues you find.  Thanks to Clément Robert and Thomas
-  Caswell for the work.
+* Better support for CPUs that do not have a power of 2 number of
+  cores.  See #479 and #490.  Thanks to @avalentino.
 
-* Avoid erroring when OMP_NUM_THREADS is empty string.  Thanks to
-  Patrick Hoefler.
+* Allow numexpr to run with the multithreading package in Python.
+  See PR #496.  Thanks to @emmaai
 
-* Do not warn if OMP_NUM_THREAD set.
+* Wheels for Python 3.13 are now provided.
 
 What's Numexpr?
 ---------------

numexpr-2.10.2/PKG-INFO

@@ -0,0 +1,214 @@
+Metadata-Version: 2.1
+Name: numexpr
+Version: 2.10.2
+Summary: Fast numerical expression evaluator for NumPy
+Author-email: "David M. Cooke, Francesc Alted, and others" <blosc@blosc.org>
+Maintainer-email: Blosc Development Team <blosc@blosc.org>
+Project-URL: homepage, https://github.com/pydata/numexpr
+Project-URL: documentation, https://numexpr.readthedocs.io
+Project-URL: repository, https://github.com/pydata/numexpr
+Classifier: Development Status :: 6 - Mature
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+License-File: AUTHORS.txt
+Requires-Dist: numpy>=1.23.0
+
+======================================================
+NumExpr: Fast numerical expression evaluator for NumPy
+======================================================
+
+:Author: David M. Cooke, Francesc Alted, and others.
+:Maintainer: Francesc Alted
+:Contact: faltet@gmail.com
+:URL: https://github.com/pydata/numexpr
+:Documentation: http://numexpr.readthedocs.io/en/latest/
+:GitHub Actions: |actions|
+:PyPi: |version|
+:DOI: |doi|
+:readthedocs: |docs|
+
+.. |actions| image:: https://github.com/pydata/numexpr/workflows/Build/badge.svg
+        :target: https://github.com/pydata/numexpr/actions
+.. |travis| image:: https://travis-ci.org/pydata/numexpr.png?branch=master
+        :target: https://travis-ci.org/pydata/numexpr
+.. |docs| image:: https://readthedocs.org/projects/numexpr/badge/?version=latest
+        :target: http://numexpr.readthedocs.io/en/latest
+.. |doi| image:: https://zenodo.org/badge/doi/10.5281/zenodo.2483274.svg
+        :target:  https://doi.org/10.5281/zenodo.2483274
+.. |version| image:: https://img.shields.io/pypi/v/numexpr
+        :target: https://pypi.python.org/pypi/numexpr
+
+
+What is NumExpr?
+----------------
+
+NumExpr is a fast numerical expression evaluator for NumPy.  With it,
+expressions that operate on arrays (like :code:`'3*a+4*b'`) are accelerated
+and use less memory than doing the same calculation in Python.
+
+In addition, its multi-threaded capabilities can make use of all your
+cores -- which generally results in substantial performance scaling compared
+to NumPy.
+
+Last but not least, numexpr can make use of Intel's VML (Vector Math
+Library, normally integrated in its Math Kernel Library, or MKL).
+This allows further acceleration of transcendent expressions.
+
+
+How NumExpr achieves high performance
+-------------------------------------
+
+The main reason why NumExpr achieves better performance than NumPy is
+that it avoids allocating memory for intermediate results. This
+results in better cache utilization and reduces memory access in
+general. Due to this, NumExpr works best with large arrays.
+
+NumExpr parses expressions into its own op-codes that are then used by
+an integrated computing virtual machine. The array operands are split
+into small chunks that easily fit in the cache of the CPU and passed
+to the virtual machine. The virtual machine then applies the
+operations on each chunk. It's worth noting that all temporaries and
+constants in the expression are also chunked. Chunks are distributed among
+the available cores of the CPU, resulting in highly parallelized code
+execution.
+
+The result is that NumExpr can get the most of your machine computing
+capabilities for array-wise computations. Common speed-ups with regard
+to NumPy are usually between 0.95x (for very simple expressions like
+:code:`'a + 1'`) and 4x (for relatively complex ones like :code:`'a*b-4.1*a > 2.5*b'`),
+although much higher speed-ups can be achieved for some functions  and complex
+math operations (up to 15x in some cases).
+
+NumExpr performs best on matrices that are too large to fit in L1 CPU cache.
+In order to get a better idea on the different speed-ups that can be achieved
+on your platform, run the provided benchmarks.
+
+Installation
+------------
+
+From wheels
+^^^^^^^^^^^
+
+NumExpr is available for install via `pip` for a wide range of platforms and
+Python versions (which may be browsed at: https://pypi.org/project/numexpr/#files).
+Installation can be performed as::
+
+    pip install numexpr
+
+If you are using the Anaconda or Miniconda distribution of Python you may prefer
+to use the `conda` package manager in this case::
+
+    conda install numexpr
+
+From Source
+^^^^^^^^^^^
+
+On most \*nix systems your compilers will already be present. However if you
+are using a virtual environment with a substantially newer version of Python than
+your system Python you may be prompted to install a new version of `gcc` or `clang`.
+
+For Windows, you will need to install the Microsoft Visual C++ Build Tools
+(which are free) first. The version depends on which version of Python you have
+installed:
+
+https://wiki.python.org/moin/WindowsCompilers
+
+For Python 3.6+ simply installing the latest version of MSVC build tools should
+be sufficient. Note that wheels found via pip do not include MKL support. Wheels
+available via `conda` will have MKL, if the MKL backend is used for NumPy.
+
+See `requirements.txt` for the required version of NumPy.
+
+NumExpr is built in the standard Python way::
+
+  python setup.py build install
+
+You can test `numexpr` with::
+
+  python -c "import numexpr; numexpr.test()"
+
+Do not test NumExpr in the source directory or you will generate import errors.
+
+Enable Intel® MKL support
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+NumExpr includes support for Intel's MKL library. This may provide better
+performance on Intel architectures, mainly when evaluating transcendental
+functions (trigonometrical, exponential, ...).
+
+If you have Intel's MKL, copy the `site.cfg.example` that comes with the
+distribution to `site.cfg` and edit the latter file to provide correct paths to
+the MKL libraries in your system.  After doing this, you can proceed with the
+usual building instructions listed above.
+
+Pay attention to the messages during the building process in order to know
+whether MKL has been detected or not.  Finally, you can check the speed-ups on
+your machine by running the `bench/vml_timing.py` script (you can play with
+different parameters to the `set_vml_accuracy_mode()` and `set_vml_num_threads()`
+functions in the script so as to see how it would affect performance).
+
+Usage
+-----
+
+::
+
+  >>> import numpy as np
+  >>> import numexpr as ne
+
+  >>> a = np.arange(1e6)   # Choose large arrays for better speedups
+  >>> b = np.arange(1e6)
+
+  >>> ne.evaluate("a + 1")   # a simple expression
+  array([  1.00000000e+00,   2.00000000e+00,   3.00000000e+00, ...,
+           9.99998000e+05,   9.99999000e+05,   1.00000000e+06])
+
+  >>> ne.evaluate("a * b - 4.1 * a > 2.5 * b")   # a more complex one
+  array([False, False, False, ...,  True,  True,  True], dtype=bool)
+
+  >>> ne.evaluate("sin(a) + arcsinh(a/b)")   # you can also use functions
+  array([        NaN,  1.72284457,  1.79067101, ...,  1.09567006,
+          0.17523598, -0.09597844])
+
+  >>> s = np.array([b'abba', b'abbb', b'abbcdef'])
+  >>> ne.evaluate("b'abba' == s")   # string arrays are supported too
+  array([ True, False, False], dtype=bool)
+
+
+Documentation
+-------------
+
+Please see the official documentation at `numexpr.readthedocs.io <https://numexpr.readthedocs.io>`_.
+Included is a user guide, benchmark results, and the reference API.
+
+
+Authors
+-------
+
+Please see `AUTHORS.txt <https://github.com/pydata/numexpr/blob/master/AUTHORS.txt>`_.
+
+
+License
+-------
+
+NumExpr is distributed under the `MIT <http://www.opensource.org/licenses/mit-license.php>`_ license.
+
+
+.. Local Variables:
+.. mode: text
+.. coding: utf-8
+.. fill-column: 70
+.. End:

{numexpr-2.10.1 → numexpr-2.10.2}/RELEASE_NOTES.rst

@@ -2,21 +2,33 @@
 Release notes for NumExpr 2.10 series
 =====================================
 
+Changes from 2.10.1 to 2.10.2
+-----------------------------
+
+* Better support for CPUs that do not have a power of 2 number of
+  cores.  See #479 and #490.  Thanks to @avalentino.
+
+* Allow numexpr to run with the multithreading package in Python.
+  See PR #496.  Thanks to @emmaai
+
+* Wheels for Python 3.13 are now provided.
+
+
 Changes from 2.10.0 to 2.10.1
 -----------------------------
 
-- The default number of 'safe' threads has been upgraded to 16 (instead of
+* The default number of 'safe' threads has been upgraded to 16 (instead of
   previous 8). That means that if your CPU has > 16 cores, the default is
   to use 16. You can always override this with the "NUMEXPR_MAX_THREADS"
   environment variable.
 
-- NumPy 1.23 is now the minimum supported.
+* NumPy 1.23 is now the minimum supported.
 
-- Preliminary support for Python 3.13. Thanks to Karolina Surma.
+* Preliminary support for Python 3.13. Thanks to Karolina Surma.
 
-- Fix tests on nthreads detection (closes: #479). Thanks to @avalentino.
+* Fix tests on nthreads detection (closes: #479). Thanks to @avalentino.
 
-- The build process has been modernized and now uses the `pyproject.toml`
+* The build process has been modernized and now uses the `pyproject.toml`
   file for more of the configuration options.
 
 

numexpr-2.10.2/VERSION

@@ -0,0 +1 @@
+2.10.2

numexpr-2.10.2/bench/large_array_vs_numpy.py

@@ -0,0 +1,152 @@
+#################################################################################
+# To mimic the scenario that computation is i/o bound and constrained by memory
+#
+# It's a much simplified version that the chunk is computed in a loop,
+# and expression is evaluated in a sequence, which is not true in reality.
+# Neverthless, numexpr outperforms numpy.
+#################################################################################
+"""
+Benchmarking Expression 1:
+NumPy time (threaded over 32 chunks with 2 threads): 4.612313 seconds
+numexpr time (threaded with re_evaluate over 32 chunks with 2 threads): 0.951172 seconds
+numexpr speedup: 4.85x
+----------------------------------------
+Benchmarking Expression 2:
+NumPy time (threaded over 32 chunks with 2 threads): 23.862752 seconds
+numexpr time (threaded with re_evaluate over 32 chunks with 2 threads): 2.182058 seconds
+numexpr speedup: 10.94x
+----------------------------------------
+Benchmarking Expression 3:
+NumPy time (threaded over 32 chunks with 2 threads): 20.594895 seconds
+numexpr time (threaded with re_evaluate over 32 chunks with 2 threads): 2.927881 seconds
+numexpr speedup: 7.03x
+----------------------------------------
+Benchmarking Expression 4:
+NumPy time (threaded over 32 chunks with 2 threads): 12.834101 seconds
+numexpr time (threaded with re_evaluate over 32 chunks with 2 threads): 5.392480 seconds
+numexpr speedup: 2.38x
+----------------------------------------
+"""
+
+import os
+
+os.environ["NUMEXPR_NUM_THREADS"] = "16"
+import numpy as np
+import numexpr as ne
+import timeit
+import threading
+
+array_size = 10**8
+num_runs = 10
+num_chunks = 32  # Number of chunks
+num_threads = 2  # Number of threads constrained by how many chunks memory can hold
+
+a = np.random.rand(array_size).reshape(10**4, -1)
+b = np.random.rand(array_size).reshape(10**4, -1)
+c = np.random.rand(array_size).reshape(10**4, -1)
+
+chunk_size = array_size // num_chunks
+
+expressions_numpy = [
+    lambda a, b, c: a + b * c,
+    lambda a, b, c: a**2 + b**2 - 2 * a * b * np.cos(c),
+    lambda a, b, c: np.sin(a) + np.log(b) * np.sqrt(c),
+    lambda a, b, c: np.exp(a) + np.tan(b) - np.sinh(c),
+]
+
+expressions_numexpr = [
+    "a + b * c",
+    "a**2 + b**2 - 2 * a * b * cos(c)",
+    "sin(a) + log(b) * sqrt(c)",
+    "exp(a) + tan(b) - sinh(c)",
+]
+
+
+def benchmark_numpy_chunk(func, a, b, c, results, indices):
+    for index in indices:
+        start = index * chunk_size
+        end = (index + 1) * chunk_size
+        time_taken = timeit.timeit(
+            lambda: func(a[start:end], b[start:end], c[start:end]), number=num_runs
+        )
+        results.append(time_taken)
+
+
+def benchmark_numexpr_re_evaluate(expr, a, b, c, results, indices):
+    for index in indices:
+        start = index * chunk_size
+        end = (index + 1) * chunk_size
+        if index == 0:
+            # Evaluate the first chunk with evaluate
+            time_taken = timeit.timeit(
+                lambda: ne.evaluate(
+                    expr,
+                    local_dict={
+                        "a": a[start:end],
+                        "b": b[start:end],
+                        "c": c[start:end],
+                    },
+                ),
+                number=num_runs,
+            )
+        else:
+            # Re-evaluate subsequent chunks with re_evaluate
+            time_taken = timeit.timeit(
+                lambda: ne.re_evaluate(
+                    local_dict={"a": a[start:end], "b": b[start:end], "c": c[start:end]}
+                ),
+                number=num_runs,
+            )
+        results.append(time_taken)
+
+
+def run_benchmark_threaded():
+    chunk_indices = list(range(num_chunks))
+
+    for i in range(len(expressions_numpy)):
+        print(f"Benchmarking Expression {i+1}:")
+
+        results_numpy = []
+        results_numexpr = []
+
+        threads_numpy = []
+        for j in range(num_threads):
+            indices = chunk_indices[j::num_threads]  # Distribute chunks across threads
+            thread = threading.Thread(
+                target=benchmark_numpy_chunk,
+                args=(expressions_numpy[i], a, b, c, results_numpy, indices),
+            )
+            threads_numpy.append(thread)
+            thread.start()
+
+        for thread in threads_numpy:
+            thread.join()
+
+        numpy_time = sum(results_numpy)
+        print(
+            f"NumPy time (threaded over {num_chunks} chunks with {num_threads} threads): {numpy_time:.6f} seconds"
+        )
+
+        threads_numexpr = []
+        for j in range(num_threads):
+            indices = chunk_indices[j::num_threads]  # Distribute chunks across threads
+            thread = threading.Thread(
+                target=benchmark_numexpr_re_evaluate,
+                args=(expressions_numexpr[i], a, b, c, results_numexpr, indices),
+            )
+            threads_numexpr.append(thread)
+            thread.start()
+
+        for thread in threads_numexpr:
+            thread.join()
+
+        numexpr_time = sum(results_numexpr)
+        print(
+            f"numexpr time (threaded with re_evaluate over {num_chunks} chunks with {num_threads} threads): {numexpr_time:.6f} seconds"
+        )
+        print(f"numexpr speedup: {numpy_time / numexpr_time:.2f}x")
+        print("-" * 40)
+
+
+if __name__ == "__main__":
+    run_benchmark_threaded()

{numexpr-2.10.1 → numexpr-2.10.2}/numexpr/necompiler.py

@@ -19,7 +19,7 @@ import numpy
 
 is_cpu_amd_intel = False # DEPRECATION WARNING: WILL BE REMOVED IN FUTURE RELEASE
 from numexpr import interpreter, expressions, use_vml
-from numexpr.utils import CacheDict
+from numexpr.utils import CacheDict, ContextDict
 
 # Declare a double type that does not exist in Python space
 double = numpy.double
@@ -776,11 +776,9 @@ def getArguments(names, local_dict=None, global_dict=None, _frame_depth: int=2):
 # Dictionaries for caching variable names and compiled expressions
 _names_cache = CacheDict(256)
 _numexpr_cache = CacheDict(256)
-_numexpr_last = {}
+_numexpr_last = ContextDict()
 evaluate_lock = threading.Lock()
 
-# MAYBE: decorate this function to add attributes instead of having the 
-# _numexpr_last dictionary?
 def validate(ex: str, 
              local_dict: Optional[Dict] = None, 
              global_dict: Optional[Dict] = None,
@@ -887,7 +885,7 @@ def validate(ex: str,
             compiled_ex = _numexpr_cache[numexpr_key] = NumExpr(ex, signature, sanitize=sanitize, **context)
         kwargs = {'out': out, 'order': order, 'casting': casting,
                 'ex_uses_vml': ex_uses_vml}
-        _numexpr_last = dict(ex=compiled_ex, argnames=names, kwargs=kwargs)
+        _numexpr_last.set(ex=compiled_ex, argnames=names, kwargs=kwargs)
     except Exception as e:
         return e
     return None

{numexpr-2.10.1 → numexpr-2.10.2}/numexpr/tests/test_numexpr.py

@@ -1129,7 +1129,7 @@ class test_threading_config(TestCase):
                 "if 'NUMEXPR_MAX_THREADS' in os.environ: os.environ.pop('NUMEXPR_MAX_THREADS')",
                 "if 'OMP_NUM_THREADS' in os.environ: os.environ.pop('OMP_NUM_THREADS')",
                 "import numexpr",
-                "assert(numexpr.nthreads <= 8)",
+                f"assert(numexpr.nthreads <= {MAX_THREADS})",
                 "exit(0)"])
         subprocess.check_call([sys.executable, '-c', script])
 
@@ -1201,6 +1201,7 @@ class test_threading(TestCase):
         test.join()
 
     def test_multithread(self):
+
         import threading
 
         # Running evaluate() from multiple threads shouldn't crash
@@ -1218,6 +1219,77 @@ class test_threading(TestCase):
         for t in threads:
             t.join()
 
+    def test_thread_safety(self):
+        """
+        Expected output
+
+        When not safe (before the pr this test is commited)
+        AssertionError: Thread-0 failed: result does not match expected
+
+        When safe (after the pr this test is commited)
+        Should pass without failure
+        """
+        import threading
+        import time
+
+        barrier = threading.Barrier(4)
+
+        # Function that each thread will run with different expressions
+        def thread_function(a_value, b_value, expression, expected_result, results, index):
+            validate(expression, local_dict={"a": a_value, "b": b_value})
+            # Wait for all threads to reach this point
+            # such that they all set _numexpr_last
+            barrier.wait()
+
+            # Simulate some work or a context switch delay
+            time.sleep(0.1)
+
+            result = re_evaluate(local_dict={"a": a_value, "b": b_value})
+            results[index] = np.array_equal(result, expected_result)
+
+        def test_thread_safety_with_numexpr():
+            num_threads = 4
+            array_size = 1000000
+
+            expressions = [
+                "a + b",
+                "a - b",
+                "a * b",
+                "a / b"
+            ]
+
+            a_value = [np.full(array_size, i + 1) for i in range(num_threads)]
+            b_value = [np.full(array_size, (i + 1) * 2) for i in range(num_threads)]
+
+            expected_results = [
+                a_value[i] + b_value[i] if expr == "a + b" else
+                a_value[i] - b_value[i] if expr == "a - b" else
+                a_value[i] * b_value[i] if expr == "a * b" else
+                a_value[i] / b_value[i] if expr == "a / b" else None
+                for i, expr in enumerate(expressions)
+            ]
+
+            results = [None] * num_threads
+            threads = []
+
+            # Create and start threads with different expressions
+            for i in range(num_threads):
+                thread = threading.Thread(
+                    target=thread_function,
+                    args=(a_value[i], b_value[i], expressions[i], expected_results[i], results, i)
+                )
+                threads.append(thread)
+                thread.start()
+
+            for thread in threads:
+                thread.join()
+
+            for i in range(num_threads):
+                if not results[i]:
+                    self.fail(f"Thread-{i} failed: result does not match expected")
+
+        test_thread_safety_with_numexpr()
+
 
 # The worker function for the subprocess (needs to be here because Windows
 # has problems pickling nested functions with the multiprocess module :-/)

{numexpr-2.10.1 → numexpr-2.10.2}/numexpr/utils.py

@@ -13,6 +13,7 @@ log = logging.getLogger(__name__)
 
 import os
 import subprocess
+import contextvars
 
 from numexpr.interpreter import _set_num_threads, _get_num_threads, MAX_THREADS
 from numexpr import use_vml
@@ -226,3 +227,83 @@ class CacheDict(dict):
                 super(CacheDict, self).__delitem__(k)
         super(CacheDict, self).__setitem__(key, value)
 
+
+class ContextDict:
+    """
+    A context aware version dictionary
+    """
+    def __init__(self):
+        self._context_data = contextvars.ContextVar('context_data', default={})
+
+    def set(self, key=None, value=None, **kwargs):
+        data = self._context_data.get().copy()
+
+        if key is not None:
+            data[key] = value
+
+        for k, v in kwargs.items():
+            data[k] = v
+
+        self._context_data.set(data)
+
+    def get(self, key, default=None):
+        data = self._context_data.get()
+        return data.get(key, default)
+
+    def delete(self, key):
+        data = self._context_data.get().copy()
+        if key in data:
+            del data[key]
+        self._context_data.set(data)
+
+    def clear(self):
+        self._context_data.set({})
+
+    def all(self):
+        return self._context_data.get()
+
+    def update(self, *args, **kwargs):
+        data = self._context_data.get().copy()
+
+        if args:
+            if len(args) > 1:
+                raise TypeError(f"update() takes at most 1 positional argument ({len(args)} given)")
+            other = args[0]
+            if isinstance(other, dict):
+                data.update(other)
+            else:
+                for k, v in other:
+                    data[k] = v
+
+        data.update(kwargs)
+        self._context_data.set(data)
+
+    def keys(self):
+        return self._context_data.get().keys()
+
+    def values(self):
+        return self._context_data.get().values()
+
+    def items(self):
+        return self._context_data.get().items()
+
+    def __getitem__(self, key):
+        return self.get(key)
+
+    def __setitem__(self, key, value):
+        self.set(key, value)
+
+    def __delitem__(self, key):
+        self.delete(key)
+
+    def __contains__(self, key):
+        return key in self._context_data.get()
+
+    def __len__(self):
+        return len(self._context_data.get())
+
+    def __iter__(self):
+        return iter(self._context_data.get())
+
+    def __repr__(self):
+        return repr(self._context_data.get())

numexpr-2.10.2/numexpr/version.py

@@ -0,0 +1,5 @@
+# THIS FILE IS GENERATED BY `setup.py`
+__version__ = '2.10.2'
+version = '2.10.2'
+numpy_build_version = '2.1.3'
+platform_machine = 'AMD64'

numexpr-2.10.2/numexpr.egg-info/PKG-INFO

@@ -0,0 +1,214 @@
+Metadata-Version: 2.1
+Name: numexpr
+Version: 2.10.2
+Summary: Fast numerical expression evaluator for NumPy
+Author-email: "David M. Cooke, Francesc Alted, and others" <blosc@blosc.org>
+Maintainer-email: Blosc Development Team <blosc@blosc.org>
+Project-URL: homepage, https://github.com/pydata/numexpr
+Project-URL: documentation, https://numexpr.readthedocs.io
+Project-URL: repository, https://github.com/pydata/numexpr
+Classifier: Development Status :: 6 - Mature
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+License-File: AUTHORS.txt
+Requires-Dist: numpy>=1.23.0
+
+======================================================
+NumExpr: Fast numerical expression evaluator for NumPy
+======================================================
+
+:Author: David M. Cooke, Francesc Alted, and others.
+:Maintainer: Francesc Alted
+:Contact: faltet@gmail.com
+:URL: https://github.com/pydata/numexpr
+:Documentation: http://numexpr.readthedocs.io/en/latest/
+:GitHub Actions: |actions|
+:PyPi: |version|
+:DOI: |doi|
+:readthedocs: |docs|
+
+.. |actions| image:: https://github.com/pydata/numexpr/workflows/Build/badge.svg
+        :target: https://github.com/pydata/numexpr/actions
+.. |travis| image:: https://travis-ci.org/pydata/numexpr.png?branch=master
+        :target: https://travis-ci.org/pydata/numexpr
+.. |docs| image:: https://readthedocs.org/projects/numexpr/badge/?version=latest
+        :target: http://numexpr.readthedocs.io/en/latest
+.. |doi| image:: https://zenodo.org/badge/doi/10.5281/zenodo.2483274.svg
+        :target:  https://doi.org/10.5281/zenodo.2483274
+.. |version| image:: https://img.shields.io/pypi/v/numexpr
+        :target: https://pypi.python.org/pypi/numexpr
+
+
+What is NumExpr?
+----------------
+
+NumExpr is a fast numerical expression evaluator for NumPy.  With it,
+expressions that operate on arrays (like :code:`'3*a+4*b'`) are accelerated
+and use less memory than doing the same calculation in Python.
+
+In addition, its multi-threaded capabilities can make use of all your
+cores -- which generally results in substantial performance scaling compared
+to NumPy.
+
+Last but not least, numexpr can make use of Intel's VML (Vector Math
+Library, normally integrated in its Math Kernel Library, or MKL).
+This allows further acceleration of transcendent expressions.
+
+
+How NumExpr achieves high performance
+-------------------------------------
+
+The main reason why NumExpr achieves better performance than NumPy is
+that it avoids allocating memory for intermediate results. This
+results in better cache utilization and reduces memory access in
+general. Due to this, NumExpr works best with large arrays.
+
+NumExpr parses expressions into its own op-codes that are then used by
+an integrated computing virtual machine. The array operands are split
+into small chunks that easily fit in the cache of the CPU and passed
+to the virtual machine. The virtual machine then applies the
+operations on each chunk. It's worth noting that all temporaries and
+constants in the expression are also chunked. Chunks are distributed among
+the available cores of the CPU, resulting in highly parallelized code
+execution.
+
+The result is that NumExpr can get the most of your machine computing
+capabilities for array-wise computations. Common speed-ups with regard
+to NumPy are usually between 0.95x (for very simple expressions like
+:code:`'a + 1'`) and 4x (for relatively complex ones like :code:`'a*b-4.1*a > 2.5*b'`),
+although much higher speed-ups can be achieved for some functions  and complex
+math operations (up to 15x in some cases).
+
+NumExpr performs best on matrices that are too large to fit in L1 CPU cache.
+In order to get a better idea on the different speed-ups that can be achieved
+on your platform, run the provided benchmarks.
+
+Installation
+------------
+
+From wheels
+^^^^^^^^^^^
+
+NumExpr is available for install via `pip` for a wide range of platforms and
+Python versions (which may be browsed at: https://pypi.org/project/numexpr/#files).
+Installation can be performed as::
+
+    pip install numexpr
+
+If you are using the Anaconda or Miniconda distribution of Python you may prefer
+to use the `conda` package manager in this case::
+
+    conda install numexpr
+
+From Source
+^^^^^^^^^^^
+
+On most \*nix systems your compilers will already be present. However if you
+are using a virtual environment with a substantially newer version of Python than
+your system Python you may be prompted to install a new version of `gcc` or `clang`.
+
+For Windows, you will need to install the Microsoft Visual C++ Build Tools
+(which are free) first. The version depends on which version of Python you have
+installed:
+
+https://wiki.python.org/moin/WindowsCompilers
+
+For Python 3.6+ simply installing the latest version of MSVC build tools should
+be sufficient. Note that wheels found via pip do not include MKL support. Wheels
+available via `conda` will have MKL, if the MKL backend is used for NumPy.
+
+See `requirements.txt` for the required version of NumPy.
+
+NumExpr is built in the standard Python way::
+
+  python setup.py build install
+
+You can test `numexpr` with::
+
+  python -c "import numexpr; numexpr.test()"
+
+Do not test NumExpr in the source directory or you will generate import errors.
+
+Enable Intel® MKL support
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+NumExpr includes support for Intel's MKL library. This may provide better
+performance on Intel architectures, mainly when evaluating transcendental
+functions (trigonometrical, exponential, ...).
+
+If you have Intel's MKL, copy the `site.cfg.example` that comes with the
+distribution to `site.cfg` and edit the latter file to provide correct paths to
+the MKL libraries in your system.  After doing this, you can proceed with the
+usual building instructions listed above.
+
+Pay attention to the messages during the building process in order to know
+whether MKL has been detected or not.  Finally, you can check the speed-ups on
+your machine by running the `bench/vml_timing.py` script (you can play with
+different parameters to the `set_vml_accuracy_mode()` and `set_vml_num_threads()`
+functions in the script so as to see how it would affect performance).
+
+Usage
+-----
+
+::
+
+  >>> import numpy as np
+  >>> import numexpr as ne
+
+  >>> a = np.arange(1e6)   # Choose large arrays for better speedups
+  >>> b = np.arange(1e6)
+
+  >>> ne.evaluate("a + 1")   # a simple expression
+  array([  1.00000000e+00,   2.00000000e+00,   3.00000000e+00, ...,
+           9.99998000e+05,   9.99999000e+05,   1.00000000e+06])
+
+  >>> ne.evaluate("a * b - 4.1 * a > 2.5 * b")   # a more complex one
+  array([False, False, False, ...,  True,  True,  True], dtype=bool)
+
+  >>> ne.evaluate("sin(a) + arcsinh(a/b)")   # you can also use functions
+  array([        NaN,  1.72284457,  1.79067101, ...,  1.09567006,
+          0.17523598, -0.09597844])
+
+  >>> s = np.array([b'abba', b'abbb', b'abbcdef'])
+  >>> ne.evaluate("b'abba' == s")   # string arrays are supported too
+  array([ True, False, False], dtype=bool)
+
+
+Documentation
+-------------
+
+Please see the official documentation at `numexpr.readthedocs.io <https://numexpr.readthedocs.io>`_.
+Included is a user guide, benchmark results, and the reference API.
+
+
+Authors
+-------
+
+Please see `AUTHORS.txt <https://github.com/pydata/numexpr/blob/master/AUTHORS.txt>`_.
+
+
+License
+-------
+
+NumExpr is distributed under the `MIT <http://www.opensource.org/licenses/mit-license.php>`_ license.
+
+
+.. Local Variables:
+.. mode: text
+.. coding: utf-8
+.. fill-column: 70
+.. End:

{numexpr-2.10.1 → numexpr-2.10.2}/numexpr.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ site.cfg.example
 bench/boolean_timing.py
 bench/issue-36.py
 bench/issue-47.py
+bench/large_array_vs_numpy.py
 bench/multidim.py
 bench/poly.py
 bench/timing.py

{numexpr-2.10.1 → numexpr-2.10.2}/pyproject.toml

@@ -12,6 +12,7 @@ include = ["numexpr"]
 [project]
 name = "numexpr"
 description = "Fast numerical expression evaluator for NumPy"
+readme = "README.rst"
 authors = [{name = "David M. Cooke, Francesc Alted, and others", email = "blosc@blosc.org"}]
 maintainers = [{ name = "Blosc Development Team", email = "blosc@blosc.org"}]
 classifiers = [

{numexpr-2.10.1 → numexpr-2.10.2}/setup.py

@@ -31,6 +31,10 @@ with open('numexpr/version.py', 'w') as fh:
         pass
     fh.write("platform_machine = '%s'\n" % platform.machine())
 
+# Read the contents of your README file
+with open('README.rst', encoding='utf-8') as f:
+    long_description = f.read()
+
 lib_dirs = []
 inc_dirs = [np.get_include()]
 libs = []  # Pre-built libraries ONLY, like python36.so
@@ -101,6 +105,8 @@ def setup_package():
 
     metadata = dict(
         version=version,
+        long_description=long_description,
+        long_description_content_type='text/x-rst',
         install_requires=requirements,
         libraries=clibs,
         ext_modules=[

numexpr-2.10.1/PKG-INFO

@@ -1,27 +0,0 @@
-Metadata-Version: 2.1
-Name: numexpr
-Version: 2.10.1
-Summary: Fast numerical expression evaluator for NumPy
-Author-email: "David M. Cooke, Francesc Alted, and others" <blosc@blosc.org>
-Maintainer-email: Blosc Development Team <blosc@blosc.org>
-Project-URL: homepage, https://github.com/pydata/numexpr
-Project-URL: documentation, https://numexpr.readthedocs.io
-Project-URL: repository, https://github.com/pydata/numexpr
-Classifier: Development Status :: 6 - Mature
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Information Technology
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: Unix
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.9
-License-File: LICENSE.txt
-License-File: AUTHORS.txt
-Requires-Dist: numpy>=1.23.0

numexpr-2.10.1/VERSION

@@ -1 +0,0 @@
-2.10.1

numexpr-2.10.1/numexpr/version.py

@@ -1,5 +0,0 @@
-# THIS FILE IS GENERATED BY `setup.py`
-__version__ = '2.10.1'
-version = '2.10.1'
-numpy_build_version = '2.0.0'
-platform_machine = 'AMD64'

numexpr-2.10.1/numexpr.egg-info/PKG-INFO

@@ -1,27 +0,0 @@
-Metadata-Version: 2.1
-Name: numexpr
-Version: 2.10.1
-Summary: Fast numerical expression evaluator for NumPy
-Author-email: "David M. Cooke, Francesc Alted, and others" <blosc@blosc.org>
-Maintainer-email: Blosc Development Team <blosc@blosc.org>
-Project-URL: homepage, https://github.com/pydata/numexpr
-Project-URL: documentation, https://numexpr.readthedocs.io
-Project-URL: repository, https://github.com/pydata/numexpr
-Classifier: Development Status :: 6 - Mature
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Information Technology
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: Unix
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.9
-License-File: LICENSE.txt
-License-File: AUTHORS.txt
-Requires-Dist: numpy>=1.23.0