tlc.core.objects.tables.from_table.subset_table¶

A Table whose rows are a subset of another Table.

Module Contents¶

Classes¶

Class

Description

SubsetTable

A procedural table where rows in an input table are optionally included given

API¶

class SubsetTable(
*,
url: Url | None = None,
created: str | None = None,
description: str | None = None,
init_parameters: Any = None,
row_cache_url: Url | None = None,
row_cache_populated: bool | None = None,
input_table_url: Url | Table | None = None,
range_factor_min: float | None = None,
range_factor_max: float | None = None,
include_probability: float | None = None,
input_tables: list[Url] | None = None,
)¶

Bases: tlc.core.objects.tables.in_memory_rows_table._InMemoryRowsTable

A procedural table where rows in an input table are optionally included given

  • An include range factor min/max (where 0 mean start of table, and 1 means end)

  • An ‘include_probability’ which determines the ratio of rows in the range to include. The actual probabilities are generated by a pseudo-random generator which guarantees identical outputs for identical configurations

Create a SubsetTable.

Parameters:
  • url – The URL where the table should be persisted.

  • created – The creation timestamp for the table.

  • description – A description of the table.

  • init_parameters – Parameters used during object initialization.

  • row_cache_url – The URL for caching rows.

  • row_cache_populated – Flag indicating if the row cache is populated.

  • input_table_url – The URL or table reference for the input table.

  • range_factor_min – The minimum range factor (0 means start of table).

  • range_factor_max – The maximum range factor (1 means end of table).

  • include_probability – The probability of including each row in the range.

  • input_tables – Optional list of Tables or URLs to record as input tables for lineage tracking.

property seed: int¶

A deterministic seed for random number generation determined from object properties

To be used when including rows based on probability.
Returns:

A random number seed

Return type:

int