Detail: Batch: Display

Overview: Batch: Display

Batch.interface

A Frame documenting the interface of this class.

>>> bt = sf.Batch((('i', sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), index=sf.IndexHierarchy.from_product((0, 1), ('p', 'q')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x')), ('j', sf.Frame.from_fields(((23, 83, 19, 87), (True, True, False, False), ('2022-01-01', '2023-04-01', '2022-12-31', '2024-06-30')), index=sf.IndexHierarchy.from_product((0, 1), ('p', 'q')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'))))
>>> bt
<Batch max_workers=None>
>>> bt.interface
<Frame>
<Index>                              cls_name group                doc                  <<U18>
<Index: signature>
__init__(items, *, name, config, ... Batch    Constructor          Default construct...
from_duckdb(fp, *, config, max_wo... Batch    Constructor          Given a file path...
from_frames(frames, *, name, conf... Batch    Constructor          Return a Batch fr...
from_hdf5(fp, *, config, max_work... Batch    Constructor          Given a file path...
from_sqlite(fp, *, config, max_wo... Batch    Constructor          Given a file path...
from_xlsx(fp, *, config, max_work... Batch    Constructor          Given a file path...
from_zip_csv(fp, *, config, max_w... Batch    Constructor          Given a file path...
from_zip_npy(fp, *, config, max_w... Batch    Constructor          Given a file path...
from_zip_npz(fp, *, config, max_w... Batch    Constructor          Given a file path...
from_zip_parquet(fp, *, config, m... Batch    Constructor          Given a file path...
from_zip_pickle(fp, *, config, ma... Batch    Constructor          Given a file path...
from_zip_tsv(fp, *, config, max_w... Batch    Constructor          Given a file path...
to_bus(*, index_constructor)         Batch    Exporter             Realize the Batch...
to_duckdb(fp, *, config)             Batch    Exporter             Write the complet...
to_frame(*, axis, union, index, ...) Batch    Exporter             Consolidate store...
to_hdf5(fp, *, config)               Batch    Exporter             Write the complet...
to_series(*, dtype, name, index_c... Batch    Exporter             Consolidate store...
...                                  ...      ...                  ...
via_hashlib(include_name, include... Batch    Accessor Hashlib
via_hashlib(include_name, include... Batch    Accessor Hashlib
via_hashlib(include_name, include... Batch    Accessor Hashlib
via_hashlib(include_name, include... Batch    Accessor Hashlib
via_hashlib(include_name, include... Batch    Accessor Hashlib
via_hashlib(include_name, include... Batch    Accessor Hashlib
via_hashlib(include_name, include... Batch    Accessor Hashlib
via_hashlib(include_name, include... Batch    Accessor Hashlib
via_type_clinic.to_hint()            Batch    Accessor Type Clinic Return the type h...
via_type_clinic.check(hint, *, fa... Batch    Accessor Type Clinic Given a hint (a t...
via_type_clinic.warn(hint, *, fai... Batch    Accessor Type Clinic Given a hint (a t...
via_type_clinic.__call__(hint, *,... Batch    Accessor Type Clinic Given a hint (a t...
via_type_clinic.__repr__()           Batch    Accessor Type Clinic Return a compact ...
reduce.from_func(func, *, fill_va... Batch    Accessor Reduce
reduce.from_map_func(func, *, fil... Batch    Accessor Reduce
reduce.from_label_map(func_map, *... Batch    Accessor Reduce
reduce.from_label_pair_map(func_m... Batch    Accessor Reduce
<<U90>                               <<U5>    <<U27>               <<U83>
Batch.__repr__()[source]

Provide a display of the Batch that does not exhaust the generator.

>>> bt = sf.Batch((('i', sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), index=sf.IndexHierarchy.from_product((0, 1), ('p', 'q')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x')), ('j', sf.Frame.from_fields(((23, 83, 19, 87), (True, True, False, False), ('2022-01-01', '2023-04-01', '2022-12-31', '2024-06-30')), index=sf.IndexHierarchy.from_product((0, 1), ('p', 'q')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'))))
>>> repr(bt)
<Batch max_workers=None>
Batch.__str__()

Return str(self).

>>> bt = sf.Batch((('i', sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), index=sf.IndexHierarchy.from_product((0, 1), ('p', 'q')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x')), ('j', sf.Frame.from_fields(((23, 83, 19, 87), (True, True, False, False), ('2022-01-01', '2023-04-01', '2022-12-31', '2024-06-30')), index=sf.IndexHierarchy.from_product((0, 1), ('p', 'q')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'))))
>>> str(bt)
<Batch max_workers=None>
Batch.display(config=None, *, style_config=None)[source]

Provide a Series-style display of the Batch. Note that if the held iterator is a generator, this display will exhaust the generator.

>>> bt = sf.Batch((('i', sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), index=sf.IndexHierarchy.from_product((0, 1), ('p', 'q')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x')), ('j', sf.Frame.from_fields(((23, 83, 19, 87), (True, True, False, False), ('2022-01-01', '2023-04-01', '2022-12-31', '2024-06-30')), index=sf.IndexHierarchy.from_product((0, 1), ('p', 'q')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'))))
>>> bt.display()
<Batch>
<Index>
i       <Frame>
j       <Frame>
<<U1>   <object>
>>> bt.display(sf.DisplayConfig(type_show=False))
i <Frame>
j <Frame>
Batch.display_tall(config=None)

Maximize vertical presentation. Return a static_frame.Display, capable of providing a string representation.

Parameters:

config – A static_frame.DisplayConfig instance. If not provided, the static_frame.DisplayActive will be used.

>>> bt = sf.Batch((('i', sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), index=sf.IndexHierarchy.from_product((0, 1), ('p', 'q')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x')), ('j', sf.Frame.from_fields(((23, 83, 19, 87), (True, True, False, False), ('2022-01-01', '2023-04-01', '2022-12-31', '2024-06-30')), index=sf.IndexHierarchy.from_product((0, 1), ('p', 'q')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'))))
>>> bt.display_tall()
<Batch>
<Index>
i       <Frame>
j       <Frame>
<<U1>   <object>
Batch.display_wide(config=None)

Maximize horizontal presentation. Return a static_frame.Display, capable of providing a string representation.

Parameters:

config – A static_frame.DisplayConfig instance. If not provided, the static_frame.DisplayActive will be used.

>>> bt = sf.Batch((('i', sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), index=sf.IndexHierarchy.from_product((0, 1), ('p', 'q')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x')), ('j', sf.Frame.from_fields(((23, 83, 19, 87), (True, True, False, False), ('2022-01-01', '2023-04-01', '2022-12-31', '2024-06-30')), index=sf.IndexHierarchy.from_product((0, 1), ('p', 'q')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x'))))
>>> bt.display_wide()
<Batch>
<Index>
i       <Frame>
j       <Frame>
<<U1>   <object>

Batch: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Operator Binary | Operator Unary | Accessor Values | Accessor Datetime | Accessor String | Accessor Transpose | Accessor Fill Value | Accessor Regular Expression | Accessor Hashlib | Accessor Type Clinic | Accessor Reduce