-
Notifications
You must be signed in to change notification settings - Fork 19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
LazyArray examples #257
LazyArray examples #257
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -86,6 +86,27 @@ def eval(self, item, **kwargs): | |
* If self is a LazyArray from an udf, the kwargs used to store the resulting | ||
array will be the ones passed to the constructor in :func:`lazyudf` (except the | ||
`urlpath`) updated with the kwargs passed when calling this method. | ||
|
||
Examples | ||
-------- | ||
>>> import blosc2 | ||
>>> import numpy as np | ||
>>> dtype = np.float64 | ||
>>> shape = [3, 3] | ||
>>> size = shape[0] * shape[1] | ||
>>> a = np.linspace(0, 5, num=size, dtype=dtype).reshape(shape) | ||
>>> b = np.linspace(0, 5, num=size, dtype=dtype).reshape(shape) | ||
>>> # Convert numpy arrays to Blosc2 arrays | ||
>>> a1 = blosc2.asarray(a) | ||
>>> b1 = blosc2.asarray(b) | ||
>>> # Perform the mathematical operation | ||
>>> expr = a1 + b1 | ||
>>> output = expr.eval() | ||
>>> f"Result of a + b (Lazy evaluation): {output[:]}" | ||
Result of a + b (Lazy evaluation): | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please do not use upper case in the middle of sentences. For example, above "Lazy" -> "lazy". |
||
[[ 0. 1.25 2.5 ] | ||
[ 3.75 5. 6.25] | ||
[ 7.5 8.75 10. ]] | ||
""" | ||
pass | ||
|
||
|
@@ -103,6 +124,26 @@ def __getitem__(self, item): | |
------- | ||
out: np.ndarray | ||
An array with the data containing the slice evaluated. | ||
|
||
Examples | ||
-------- | ||
>>> import blosc2 | ||
>>> import numpy as np | ||
>>> dtype = np.float64 | ||
>>> shape = [30, 4] | ||
>>> size = shape[0] * shape[1] | ||
>>> a = np.linspace(0, 10, num=size, dtype=dtype).reshape(shape) | ||
>>> b = np.linspace(0, 10, num=size, dtype=dtype).reshape(shape) | ||
>>> # Convert numpy arrays to Blosc2 arrays | ||
>>> a1 = blosc2.asarray(a) | ||
>>> b1 = blosc2.asarray(b) | ||
>>> # Perform the mathematical operation | ||
>>> expr = a1 + b1 # LazyExpr expression | ||
>>> expr[3] | ||
[2.01680672 2.18487395 2.35294118 2.5210084 ] | ||
>>> expr[2:4] | ||
[[1.34453782 1.51260504 1.68067227 1.8487395 ] | ||
[2.01680672 2.18487395 2.35294118 2.5210084 ]] | ||
""" | ||
pass | ||
|
||
|
@@ -128,6 +169,30 @@ def save(self, **kwargs): | |
if its source is a :ref:`SChunk`, :ref:`NDArray` or a :ref:`C2Array` (see :func:`blosc2.open` notes | ||
section for more info). | ||
* This is currently only supported for :ref:`LazyExpr`. | ||
|
||
Examples | ||
-------- | ||
>>> import blosc2 | ||
>>> import numpy as np | ||
>>> dtype = np.float64 | ||
>>> shape = [3, 3] | ||
>>> size = shape[0] * shape[1] | ||
>>> a = np.linspace(0, 5, num=size, dtype=dtype).reshape(shape) | ||
>>> b = np.linspace(0, 5, num=size, dtype=dtype).reshape(shape) | ||
>>> # Define file paths for storing the arrays | ||
>>> a_path = 'a_array.b2nd' | ||
>>> b_path = 'b_array.b2nd' | ||
>>> a1 = blosc2.asarray(a, urlpath=a_path, mode='w') | ||
>>> b1 = blosc2.asarray(b, urlpath=b_path, mode='w') | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As
and it reads better IMO. |
||
>>> # Perform the mathematical operation to create a LazyExpr expression | ||
>>> expr = a1 + b1 | ||
>>> # Save the LazyExpr to disk | ||
>>> expr.save(urlpath='lazy_array.b2nd', mode='w') | ||
>>> # Open and load the LazyExpr from disk | ||
>>> disk_expr = blosc2.open('lazy_array.b2nd') | ||
>>> disk_expr[:2] | ||
[[0. 1.25 2.5 ] | ||
[3.75 5. 6.25]] | ||
""" | ||
pass | ||
|
||
|
@@ -1904,6 +1969,30 @@ def lazyudf(func, inputs, dtype, chunked_eval=True, **kwargs): | |
out: :ref:`LazyUDF` | ||
A :ref:`LazyUDF` is returned. | ||
|
||
Examples | ||
-------- | ||
>>> import blosc2 | ||
>>> import numpy as np | ||
>>> dtype = np.float64 | ||
>>> shape = [3, 3] | ||
>>> size = shape[0] * shape[1] | ||
>>> a = np.linspace(0, 10, num=size, dtype=dtype).reshape(shape) | ||
>>> b = np.linspace(10, 20, num=size, dtype=dtype).reshape(shape) | ||
>>> a1 = blosc2.asarray(a) | ||
>>> b1 = blosc2.asarray(b) | ||
>>> # Define a user-defined function that will be applied to each block of data | ||
>>> def my_function(inputs_tuple, output, offset): | ||
>>> a, b = inputs_tuple | ||
>>> output[:] = a + b | ||
>>> # Create a LazyUDF object using the user-defined function | ||
>>> lazy_udf = blosc2.lazyudf(my_function, [a1, b1], dtype) | ||
>>> type(lazy_udf) | ||
<class 'blosc2.lazyexpr.LazyUDF'> | ||
>>> f"Result of LazyUDF Evaluation: {lazy_udf[:]}" | ||
Result of LazyUDF Evaluation: | ||
[[10. 12.5 15. ] | ||
[17.5 20. 22.5] | ||
[25. 27.5 30. ]] | ||
""" | ||
return LazyUDF(func, inputs, dtype, chunked_eval, **kwargs) | ||
|
||
|
@@ -1933,6 +2022,32 @@ def lazyexpr(expression, operands=None, out=None, where=None): | |
out: :ref:`LazyExpr` | ||
A :ref:`LazyExpr` is returned. | ||
|
||
Examples | ||
-------- | ||
>>> import blosc2 | ||
>>> import numpy as np | ||
>>> dtype = np.float64 | ||
>>> shape = [3, 3] | ||
>>> size = shape[0] * shape[1] | ||
>>> a = np.linspace(0, 5, num=size, dtype=dtype).reshape(shape) | ||
>>> b = np.linspace(0, 5, num=size, dtype=dtype).reshape(shape) | ||
>>> a1 = blosc2.asarray(a) | ||
>>> a1[:] | ||
[[0. 0.625 1.25 ] | ||
[1.875 2.5 3.125] | ||
[3.75 4.375 5. ]] | ||
>>> b1 = blosc2.asarray(b) | ||
>>> expr = 'a1 * b1 + 2' | ||
>>> operands = { 'a': a1, 'b': b1 } | ||
>>> lazy_expr = blosc2.lazyexpr(expr, operands=operands) | ||
>>> f"Lazy Expression Created: {lazy_expr}" | ||
Lazy Expression Created: a1 * b1 + 2 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. At this point it should be illustrative to get some results out of the lazy expression |
||
>>> expr_ = a1 * b1 + 2 | ||
>>> result = expr_.eval() | ||
>>> result[:] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The above two line can be fused into one: |
||
[[ 2. 2.390625 3.5625 ] | ||
[ 5.515625 8.25 11.765625] | ||
[16.0625 21.140625 27. ]] | ||
""" | ||
if isinstance(expression, LazyExpr): | ||
if operands is not None: | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the future, you can change these kind of lines, for
size = np.prod(shape)