Detail: Quilt: Attribute#

Quilt.STATIC = True#

>>> q = sf.Quilt.from_frame(sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'), retain_labels=True, chunksize=2, label_extractor=lambda x: str(x.iloc[0]))
>>> q.STATIC
True

Quilt.bus#

The Bus instance assigned to this Quilt.

>>> q = sf.Quilt.from_frame(sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'), retain_labels=True, chunksize=2, label_extractor=lambda x: str(x.iloc[0]))
>>> q.bus
<Bus: x>
<Index>
0        Frame
2        Frame
<<U1>    <object>

Quilt.columns#

The IndexBase instance assigned for column labels.

>>> q = sf.Quilt.from_frame(sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'), retain_labels=True, chunksize=2, label_extractor=lambda x: str(x.iloc[0]))
>>> q.columns
<Index>
a
b
c
<<U1>

Quilt.index#

The IndexBase instance assigned for row labels.

>>> q = sf.Quilt.from_frame(sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'), retain_labels=True, chunksize=2, label_extractor=lambda x: str(x.iloc[0]))
>>> q.index
<IndexHierarchy>
0                0
0                1
2                2
2                3
<<U1>            <int64>

Quilt.inventory#

Return a Frame indicating file_path, last-modified time, and size of underlying disk-based data stores if used for this Quilt.

>>> q1 = sf.Quilt.from_frame(sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'), retain_labels=True, chunksize=2, label_extractor=lambda x: str(x.iloc[0]))
>>> q1.to_zip_npz("/tmp/q.zip")
>>> q2 = sf.Quilt.from_zip_npz("/tmp/q.zip", retain_labels=True)
>>> q2.inventory
<Frame>
<Index>  path       last_modified        size    <<U13>
<Index>
None     /tmp/q.zip 2026-03-18T00:43:10… 1.12 KB
<object> <<U10>     <<U32>               <<U7>

Quilt.memory#

A MemoryDisplay, providing the size in memory of this object. For compound containers, component sizes will also be provided. Size can be interpreted through six combinations of three configurations:

L: Local: memory ignoring referenced array data provided via views. LM: Local Materialized: memory where arrays that are locally owned report their byte payload LMD: Local Materialized Data: locally owned memory of arrays byte payloads, excluding all other components

R: Referenced: memory including referenced array data provided via views RM: Referenced Materialized: memory where arrays that are locally owned or referenced report their byte payload RMD: Referenced Materialized Data: localy owned and referenced array byte payloads, excluding all other components

>>> q = sf.Quilt.from_frame(sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'), retain_labels=True, chunksize=2, label_extractor=lambda x: str(x.iloc[0]))
>>> q.memory
      L    Lu    LM   LMu   LMD  LMDu  R     Ru    RM   RMu   RMD  RMDu
Total 8.71 KB    5.76 KB    4.01 KB    17.22 KB    5.84 KB    4.09 KB

Quilt.name#

A hashable label attached to this container.

Returns:: Hashable

>>> q = sf.Quilt.from_frame(sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'), retain_labels=True, chunksize=2, label_extractor=lambda x: str(x.iloc[0]))
>>> q.name
x

Quilt.nbytes#

Return the total bytes of the underlying NumPy arrays.

Returns:: int

>>> q = sf.Quilt.from_frame(sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'), retain_labels=True, chunksize=2, label_extractor=lambda x: str(x.iloc[0]))
>>> q.nbytes
68

Quilt.ndim#

Return the number of dimensions, which for a Frame is always 2.

Returns:: int

>>> q = sf.Quilt.from_frame(sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'), retain_labels=True, chunksize=2, label_extractor=lambda x: str(x.iloc[0]))
>>> q.ndim
2

Quilt.shape#

Return a tuple describing the shape of the underlying NumPy array.

Returns:: tp.Tuple[int]

>>> q = sf.Quilt.from_frame(sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'), retain_labels=True, chunksize=2, label_extractor=lambda x: str(x.iloc[0]))
>>> q.shape
(4, 3)

Quilt.size#

Return the size of the underlying NumPy array.

Returns:: int

>>> q = sf.Quilt.from_frame(sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'), retain_labels=True, chunksize=2, label_extractor=lambda x: str(x.iloc[0]))
>>> q.size
12

Quilt.status#

Return a Frame indicating loaded status, size, bytes, and shape of all loaded Frame in the contained Quilt.

>>> q1 = sf.Quilt.from_frame(sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'), retain_labels=True, chunksize=2, label_extractor=lambda x: str(x.iloc[0]))
>>> q1.to_zip_npz("/tmp/q.zip")
>>> q2 = sf.Quilt.from_zip_npz("/tmp/q.zip", retain_labels=True)
>>> q2.status
<Frame>
<Index> loaded size      nbytes    shape    <<U6>
<Index>
0       False  nan       nan       None
2       False  nan       nan       None
<<U1>   <bool> <float64> <float64> <object>