arviz_base.explode_dataset_dims

arviz_base.explode_dataset_dims(ds, dim, labeller=None)

Explode dims of a dataset so each slice along them becomes its own variable.

Parameters:

dsxarray.Dataset

dimhashable or sequence of hashable

Dimension or dimensions along which slices to be stored as independent variables should be defined.

labellerlabeller, optional

Instance of a labeller class used to label the slices generated when exploding along dim. The method make_label_flat is used.

Returns:

xarray.Dataset

The dataset with all variables that have dim exploded into the respective slices as new variables.

Examples

In some cases, instead of theta as a (..., school) shape variable we’ll want independent variables for each slice:

from arviz_base import load_arviz_data, explode_dataset_dims
import xarray as xr

idata = load_arviz_data("centered_eight")
explode_dataset_dims(idata.posterior.dataset, "school")

<xarray.Dataset> Size: 164kB
Dimensions:                  (chain: 4, draw: 500)
Coordinates:
  * chain                    (chain) int64 32B 0 1 2 3
  * draw                     (draw) int64 4kB 0 1 2 3 4 ... 495 496 497 498 499
Data variables:
    mu                       (chain, draw) float64 16kB 1.716 1.903 ... 10.24
    theta[Choate]            (chain, draw) float64 16kB 2.317 0.8892 ... 10.46
    theta[Deerfield]         (chain, draw) float64 16kB 1.45 0.7429 ... 13.71
    theta[Phillips Andover]  (chain, draw) float64 16kB 2.086 3.126 ... 10.26
    theta[Phillips Exeter]   (chain, draw) float64 16kB 2.227 2.78 ... 15.18
    theta[Hotchkiss]         (chain, draw) float64 16kB 3.072 2.835 ... 10.92
    theta[Lawrenceville]     (chain, draw) float64 16kB 2.713 1.559 ... 15.07
    theta[St. Paul's]        (chain, draw) float64 16kB 3.084 2.488 ... 14.92
    theta[Mt. Hermon]        (chain, draw) float64 16kB 1.46 1.984 ... 14.02
    tau                      (chain, draw) float64 16kB 0.8775 0.8027 ... 3.052

xarray.Dataset

• Dimensions:
  • chain: 4
  • draw: 500
• Coordinates: (2)
  • chain
    (chain)
    int64
    0 1 2 3

    array([0, 1, 2, 3])

  • draw
    (draw)
    int64
    0 1 2 3 4 5 ... 495 496 497 498 499

    array([  0,   1,   2, ..., 497, 498, 499], shape=(500,))

• Data variables: (10)
  • mu
    (chain, draw)
    float64
    1.716 1.903 1.903 ... 7.721 10.24

    array([[ 1.71572331,  1.90348113,  1.90348113, ...,  6.80504593,
             5.36844617,  6.93340474],
           [-1.61229304,  3.54456311,  3.43239461, ..., -2.25857534,
             2.49923447,  4.12738384],
           [ 9.45345034,  2.41281038,  3.9574903 , ...,  7.88657889,
             5.51847519,  7.04122405],
           [-1.22591242,  1.54915161,  0.60776222, ...,  5.40883573,
             7.72143998, 10.23715678]], shape=(4, 500))

  • theta[Choate]
    (chain, draw)
    float64
    2.317 0.8892 0.8892 ... 7.086 10.46

    array([[ 2.31739097,  0.8891702 ,  0.8891702 , ..., 13.45620242,
            13.01074853, -3.53384061],
           [ 7.78676911,  2.05025159,  7.01759107, ..., -1.41156885,
             1.25223344,  4.47394215],
           [16.81565724, -0.40236026,  6.69376961, ...,  4.96289912,
             9.0931749 ,  9.25814554],
           [ 2.88627921,  0.64364262,  6.80468094, ..., 11.40639049,
             7.08613879, 10.46439019]], shape=(4, 500))

  • theta[Deerfield]
    (chain, draw)
    float64
    1.45 0.7429 0.7429 ... 12.31 13.71

    array([[ 1.45017375,  0.74294874,  0.74294874, ..., 15.41284151,
             2.04893139,  6.09061694],
           [-5.94397836, 11.56639495, 11.95371561, ...,  2.52357395,
            12.05247025, 14.26011713],
           [11.48718071,  0.20120165,  4.28370574, ..., 10.95509264,
            11.40969674, 12.06169304],
           [ 2.23466779,  4.43423044, -5.54836088, ...,  4.44693711,
            12.31188923, 13.71430563]], shape=(4, 500))

  • theta[Phillips Andover]
    (chain, draw)
    float64
    2.086 3.126 3.126 ... 6.584 10.26

    array([[  2.08554978,   3.12586895,   3.12586895, ...,   3.18021529,
             22.49301396,  -9.87347695],
           [ -6.27914573,  11.75480422,  13.50082917, ..., -13.10762582,
             -5.38711233,  -5.43119615],
           [ 12.67831732,  -1.39207691,   4.91067317, ...,   9.57022027,
             10.32896321,  11.1609667 ],
           [  0.47189951,  -3.28831784,   0.83352477, ...,   9.21077455,
              6.5843008 ,  10.26166615]], shape=(4, 500))

  • theta[Phillips Exeter]
    (chain, draw)
    float64
    2.227 2.78 2.78 ... 10.29 15.18

    array([[ 2.2270764 ,  2.77952411,  2.77952411, ...,  8.40800381,
            12.79340885, -0.23334533],
           [ 0.79896663, -1.65160352,  1.45665763, ...,  3.54387136,
            -0.70153225, -2.98341747],
           [ 4.92452161,  4.43328498, -2.01084843, ...,  3.29346409,
            -1.80997069, -2.40155782],
           [ 7.39575126,  4.80071081,  0.99895597, ...,  6.33107417,
            10.28609307, 15.1800984 ]], shape=(4, 500))

  • theta[Hotchkiss]
    (chain, draw)
    float64
    3.072 2.835 2.835 ... 10.05 10.92

    array([[ 3.07150714,  2.83470458,  2.83470458, ..., 15.16496487,
            -3.15852117, 11.55245562],
           [ 4.16312672, -0.34647544, -1.79906605, ...,  0.24428845,
             0.15350567, -1.28330412],
           [ 6.32388759,  2.25880375,  4.45922603, ...,  1.69145573,
            10.11602847,  9.15042728],
           [-0.54563201,  1.67889844, -3.48031792, ...,  4.15077776,
            10.05016692, 10.91603029]], shape=(4, 500))

  • theta[Lawrenceville]
    (chain, draw)
    float64
    2.713 1.559 1.559 ... 11.86 15.07

    array([[ 2.712972  ,  1.55893929,  1.55893929, ...,  9.1504244 ,
            10.42960666,  0.74308358],
           [-6.42590905,  9.72646376,  5.3979042 , ...,  3.87067868,
            -3.8058521 , -0.48808597],
           [ 0.24494848,  7.99463954, -1.11152822, ..., 14.12152223,
            10.39389155, 11.25333602],
           [ 2.6996961 , -4.16933152,  0.77659959, ...,  4.81230178,
            11.85993774, 15.07090015]], shape=(4, 500))

  • theta[St. Paul's]
    (chain, draw)
    float64
    3.084 2.488 2.488 ... 7.952 14.92

    array([[ 3.08376362,  2.48750253,  2.48750253, ..., 10.89570091,
             5.62905271, 15.34509814],
           [ 5.85366982,  5.20422231,  5.73876592, ...,  0.81336889,
             6.91550863,  6.23674711],
           [10.33703134,  4.02004331,  2.78346173, ..., 10.81136422,
             7.03775798,  7.08131602],
           [-5.88574408,  8.47142025,  0.39565091, ...,  9.69325672,
             7.95226848, 14.92321025]], shape=(4, 500))

  • theta[Mt. Hermon]
    (chain, draw)
    float64
    1.46 1.984 1.984 ... 9.754 14.02

    array([[ 1.46044828,  1.98437916,  1.98437916, ...,  8.78010934,
            12.18663532,  9.61065645],
           [ 8.28407247, -0.10662151, -5.64141763, ...,  4.16593154,
             0.25392018,  2.81510541],
           [18.37384412, -5.09846392,  6.67909788, ...,  1.80438853,
             4.59510911,  6.19248663],
           [-7.09217484,  3.14086796,  2.48932359, ...,  4.91465554,
             9.75446752, 14.02312893]], shape=(4, 500))

  • tau
    (chain, draw)
    float64
    0.8775 0.8027 0.8027 ... 2.99 3.052

    array([[ 0.8774941 ,  0.80271439,  0.80271439, ...,  5.08600601,
            10.11493858,  8.07920452],
           [12.24115337,  5.47983028,  6.64791029, ...,  7.92542651,
             6.28841169,  6.79958791],
           [ 6.4434113 ,  4.12594277,  3.11972735, ...,  4.77141179,
             5.46401958,  4.77263378],
           [ 5.50797127,  2.86390738,  4.18963173, ...,  2.23648602,
             2.98965551,  3.05155936]], shape=(4, 500))