Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

doc: update io.rst for awkward array#457

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletionsdocs/api_reference/io.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,23 @@ These methods require `scipy <https://scipy.org/>`_ to be installed.

.. autofunction:: graphblas.io.mmwrite

Awkward Array
~~~~~~~~~~~~~

`Awkward Array <https://awkward-array.org/doc/main/>`_ is a library for nested,
variable-sized data, including arbitrary-length lists, records, mixed types,
and missing data, using NumPy-like idioms. Note that the intended use of the
``awkward-array``-related ``io`` functions is to convert ``graphblas`` objects to awkward,
perform necessary computations/transformations and, if required, convert the
awkward array back to ``graphblas`` format. To facilitate this conversion process,
``graphblas.io.to_awkward`` adds top-level attribute ``format``, describing the
format of the ``graphblas`` object (this attributed is used by the
``graphblas.io.from_awkward`` function to reconstruct the ``graphblas`` object).

.. autofunction:: graphblas.io.to_awkward

.. autofunction:: graphblas.io.from_awkward

Visualization
~~~~~~~~~~~~~

Expand Down
110 changes: 58 additions & 52 deletionsgraphblas/io/_awkward.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,58 +7,6 @@
_AwkwardDoublyCompressedMatrix = None


def from_awkward(A, *, name=None):
"""Create a Matrix or Vector from an Awkward Array.

The Awkward Array must have top-level parameters: format, shape

The Awkward Array must have top-level attributes based on format:
- vec/csr/csc: values, indices
- hypercsr/hypercsc: values, indices, offset_labels

Parameters
----------
A : awkward.Array
Awkward Array with values and indices
name : str, optional
Name of resulting Matrix or Vector

Returns
-------
Vector or Matrix
"""
params = A.layout.parameters
if missing := {"format", "shape"} - params.keys():
raise ValueError(f"Missing parameters: {missing}")
format = params["format"]
shape = params["shape"]

if len(shape) == 1:
if format != "vec":
raise ValueError(f"Invalid format for Vector: {format}")
return Vector.from_coo(
A.indices.layout.data, A.values.layout.data, size=shape[0], name=name
)
nrows, ncols = shape
values = A.values.layout.content.data
indptr = A.values.layout.offsets.data
if format == "csr":
cols = A.indices.layout.content.data
return Matrix.from_csr(indptr, cols, values, ncols=ncols, name=name)
if format == "csc":
rows = A.indices.layout.content.data
return Matrix.from_csc(indptr, rows, values, nrows=nrows, name=name)
if format == "hypercsr":
rows = A.offset_labels.layout.data
cols = A.indices.layout.content.data
return Matrix.from_dcsr(rows, indptr, cols, values, nrows=nrows, ncols=ncols, name=name)
if format == "hypercsc":
cols = A.offset_labels.layout.data
rows = A.indices.layout.content.data
return Matrix.from_dcsc(cols, indptr, rows, values, nrows=nrows, ncols=ncols, name=name)
raise ValueError(f"Invalid format for Matrix: {format}")


def to_awkward(A, format=None):
"""Create an Awkward Array from a GraphBLAS Matrix.

Expand DownExpand Up@@ -179,3 +127,61 @@ def indices(self): # pragma: no branch (???)
if classname:
ret = ak.with_name(ret, classname)
return ret


def from_awkward(A, *, name=None):
"""Create a Matrix or Vector from an Awkward Array.

The Awkward Array must have top-level parameters: format, shape

The Awkward Array must have top-level attributes based on format:
- vec/csr/csc: values, indices
- hypercsr/hypercsc: values, indices, offset_labels

Parameters
----------
A : awkward.Array
Awkward Array with values and indices
name : str, optional
Name of resulting Matrix or Vector

Returns
-------
Vector or Matrix

Note: the intended purpose of this function is to facilitate
conversion of an `awkward-array` that was created via `to_awkward`
function. If attempting to convert an arbitrary `awkward-array`,
make sure that the top-level attributes and parameters contain
the expected values.
"""
params = A.layout.parameters
if missing := {"format", "shape"} - params.keys():
raise ValueError(f"Missing parameters: {missing}")
format = params["format"]
shape = params["shape"]

if len(shape) == 1:
if format != "vec":
raise ValueError(f"Invalid format for Vector: {format}")
return Vector.from_coo(
A.indices.layout.data, A.values.layout.data, size=shape[0], name=name
)
nrows, ncols = shape
values = A.values.layout.content.data
indptr = A.values.layout.offsets.data
if format == "csr":
cols = A.indices.layout.content.data
return Matrix.from_csr(indptr, cols, values, ncols=ncols, name=name)
if format == "csc":
rows = A.indices.layout.content.data
return Matrix.from_csc(indptr, rows, values, nrows=nrows, name=name)
if format == "hypercsr":
rows = A.offset_labels.layout.data
cols = A.indices.layout.content.data
return Matrix.from_dcsr(rows, indptr, cols, values, nrows=nrows, ncols=ncols, name=name)
if format == "hypercsc":
cols = A.offset_labels.layout.data
rows = A.indices.layout.content.data
return Matrix.from_dcsc(cols, indptr, rows, values, nrows=nrows, ncols=ncols, name=name)
raise ValueError(f"Invalid format for Matrix: {format}")
[8]ページ先頭
©2009-2025 Movatter.jp