jsonschema for awkward forms

[maxnoe]

Description of new feature

Is there a schema available for the json / dictionary description of awkward forms?

This would be very helpful for lower-level code building form descriptions for passing data to python.

[ianna]

@maxnoe -- is this what you are looking for?

>>> import numpy as np
... import awkward as ak
... 
... offsets = np.array([0, 2, 4, 7, 10, 10], dtype=cp.int64)
... content = np.array(
...     [1.1, 2.2, 3.3, 4.4, 5.5, 6.6, 7.7, 8.8, 9.9, 10.10], dtype=np.float64
... )
... layout = ak.contents.ListOffsetArray(
...     ak.index.Index(offsets), ak.contents.NumpyArray(content)
... )
>>> layout
<ListOffsetArray len='5'>
    <offsets><Index dtype='int64' len='6'>
        [ 0  2  4  7 10 10]
    </Index></offsets>
    <content><NumpyArray dtype='float64' len='10'>
        [ 1.1  2.2  3.3  4.4  5.5  6.6  7.7  8.8  9.9 10.1]
    </NumpyArray></content>
</ListOffsetArray>
>>> layout.form
ListOffsetForm('i64', NumpyForm('float64'))
>>> layout.form.to_json()
'{"class": "ListOffsetArray", "offsets": "i64", "content": {"class": "NumpyArray", "primitive": "float64", "inner_shape": [], "parameters": {}, "form_key": null}, "parameters": {}, "form_key": null}'

[maxnoe]

No, I'm looking for the schema of what to_json returns / from_json expects.

[ianna]

I guess that’s the best description of it

awkward/src/awkward/operations/ak_from_json.py

Line 218 in db98572

JSONSchemas

[maxnoe]

@ianna I think you are misunderstanding. What you linked is the functionality of validating the data payload using a schema.

I'm interested in the schema of the awkward layout description.

Maybe @jpivarski can help here