aligned.local.job.FileFactualJob

class documentation

class FileFactualJob(RetrivalJob): (source)

Undocumented

Method	`describe`	Undocumented
Async Method	`file_transformations`	Selects only the wanted subset from the loaded source
Method	`log_each_job`	Undocumented
Async Method	`to_lazy_polars`	Undocumented
Async Method	`to_pandas`	Undocumented
Class Variable	`date_formatter`	Undocumented
Class Variable	`facts`	Undocumented
Class Variable	`requests`	Undocumented
Class Variable	`source`	Undocumented
Property	`request_result`	Undocumented
Property	`retrival_requests`	Undocumented

Inherited from RetrivalJob:

Static Method	`from_convertable`	Undocumented
Static Method	`from_dict`	Undocumented
Static Method	`from_lazy_function`	Undocumented
Static Method	`from_polars_df`	Undocumented
Method	`aggregate`	Undocumented
Method	`cache_raw_data`	Undocumented
Method	`cached_at`	Undocumented
Method	`chuncked`	Undocumented
Method	`combined_features`	Undocumented
Method	`derive_features`	Undocumented
Method	`drop_duplicate_entities`	Undocumented
Method	`drop_invalid`	Drops invalid row based on the defined features.
Method	`ensure_types`	Undocumented
Method	`fill_missing_columns`	Undocumented
Method	`filter`	Filters based on a condition referencing either a feature, a feature name, or an polars expression to filter on.
Method	`ignore_event_timestamp`	Undocumented
Method	`inject_store`	Undocumented
Method	`join`	Undocumented
Method	`join_asof`	Undocumented
Method	`listen_to_events`	Undocumented
Method	`monitor_time_used`	Undocumented
Method	`on_load`	Undocumented
Method	`polars_method`	Undocumented
Method	`remove_derived_features`	Undocumented
Method	`rename`	Undocumented
Method	`return_invalid`	Undocumented
Method	`select`	Undocumented
Method	`select_columns`	Undocumented
Method	`split`	Undocumented
Async Method	`to_polars`	Undocumented
Method	`train_test`	Undocumented
Method	`train_test_validate`	Undocumented
Method	`transform_polars`	Undocumented
Method	`unique_entities`	Undocumented
Method	`unique_on`	Undocumented
Method	`unpack_embeddings`	Undocumented
Method	`update_vector_index`	Undocumented
Method	`validate_entites`	Undocumented
Method	`with_request`	Undocumented
Method	`with_subfeatures`	Undocumented
Method	`without_derived_features`	Undocumented
Async Method	`write_to_source`	Writes the output of the retrival job to the passed source.
Property	`loaded_columns`	Undocumented

def describe(self) -> str: (source) ¶

overrides aligned.retrival_job.RetrivalJob.describe

Undocumented

async def file_transformations(self, df: pl.LazyFrame) -> pl.LazyFrame: (source) ¶

Selects only the wanted subset from the loaded source

`python await self.file_transformations(await self.source.to_polars()) `

Args:: df (pl.LazyFrame): The loaded file source which contains all features
Returns:: pl.LazyFrame: The subset of the source which is needed for the request

def log_each_job(self, logger_func: Callable[[object], None] | None = None) -> RetrivalJob: (source) ¶

overrides aligned.retrival_job.RetrivalJob.log_each_job

Undocumented

async def to_lazy_polars(self) -> pl.LazyFrame: (source) ¶

overrides aligned.retrival_job.RetrivalJob.to_lazy_polars

Undocumented

async def to_pandas(self) -> pd.DataFrame: (source) ¶

overrides aligned.retrival_job.RetrivalJob.to_pandas

Undocumented

date_formatter: DateFormatter = (source) ¶

Undocumented

facts: RetrivalJob = (source) ¶

Undocumented

requests: list[RetrivalRequest] = (source) ¶

Undocumented

source: DataFileReference | RetrivalJob = (source) ¶

Undocumented

@property
request_result: RequestResult = (source) ¶

overrides aligned.retrival_job.RetrivalJob.request_result

Undocumented

@property
retrival_requests: list[RetrivalRequest] = (source) ¶

overrides aligned.retrival_job.RetrivalJob.retrival_requests

Undocumented