A practical PRAGMA model implementation for tokenized tabular event histories
Project description
fastpragma
An easy-to-use API for foundation model development, based on the PRAGMA framework.
Installation
Install latest from the GitHub repository:
pip install git+https://github.com/risheekkumarb/fastpragma.git
Install from conda:
conda install -c risheekkumarb fastpragma
Install from pypi:
pip install fastpragma
Documentation
Documentation can be found on this GitHub repository's pages. Package-manager-specific pages are also available on conda and pypi.
Usage
fastpragma currently exposes three main layers:
- Data — declare profile/event sources with
DataSource, then tokenize them withPRAGMADataset - Dataloading — read tokenized parquet shards with
pragma_dl/pragma_dls - Model + training — build a PRAGMA-style model with
PRAGMAModel,pragma_model, orpragma_learner
The API is still evolving, so this README focuses on the pieces implemented in the notebooks today.
import polars as pl
from fastai.data.external import untar_data, URLs
from fastcore.all import *
from fastpragma.data import DataSource, PRAGMADataset
from fastpragma.dataloader import pragma_dl
from fastpragma.model import pragma_dls, pragma_model, pragma_learner
Data format
fastpragma expects data in two broad forms:
- Profile data — one row per entity, containing relatively static attributes.
- Event data — many rows per entity, each with a timestamp.
Each source declares which columns are:
cats: categorical fieldsconts: continuous numerical fieldssigned_conts: continuous numerical fields where sign matters separatelytexts: free-text fieldslifelong: timestamp/milestone fields in profile data
Example: MovieLens 100K
This example loads the classic MovieLens 100K dataset into polars DataFrames.
Creating data sources
Use DataSource to declare how each DataFrame should be interpreted.
Profile sources use is_profile=True and normally do not need a time_col.
Event sources provide a time_col.
path = untar_data(URLs.ML_100k)
events_df = pl.scan_csv(
path/'u.data',
separator='\t',
has_header=False,
new_columns=['user_id','movie_id','rating','timestamp'],
)
events_df = events_df.with_columns(pl.from_epoch('timestamp', time_unit='s').alias('timestamp'))
ratings = DataSource(events_df, entity_col='user_id', cats=['movie_id','rating'], time_col='timestamp', name='events_df')
ratings
profile_df = pl.scan_csv(
path/'u.user',
separator='|',
has_header=False,
new_columns=['user_id','age','gender','occupation','zip_code'],
)
profile = DataSource(
profile_df,
entity_col='user_id',
cats=['gender','zip_code'],
conts=['age'],
texts=['occupation'],
name='users',
is_profile=True,
)
profile
Building a PRAGMADataset
PRAGMADataset combines one optional profile source and one or more event sources.
It fits a tokenizer, converts sources into key-value-time tokens, and writes entity-sharded parquet files.
dataset = PRAGMADataset(profile=profile, events=[ratings], entity_col="user_id", out_path="data")
# Fit vocabularies and numerical buckets.
tok = dataset.fit_tokenizer(num_buckets=10, cardinality_threshold=100)
# Write tokenized entity shards.
shard_dir = dataset.write_kv(eval_time="1998-04-01T00:00:00", n_shards=4)
Dataloaders
pragma_dl creates a PyTorch/fastai-compatible dataloader from tokenized parquet shards.
For masked-language-model pre-training, pass mask=True and the fitted tokenizer.
shards = sorted(Path(shard_dir).glob("shard_*.parquet"))
dl = pragma_dl(shards, entity_col="user_id", max_tokens=1500, shuffle=True, tok=tok, mask=True)
For training with fastai, pragma_dls creates train/validation DataLoaders from the shard list.
dls = pragma_dls(shards, tok=tok, max_tokens=1500)
Model and training
The implemented model is an encoder-only PRAGMA-style architecture with three main pieces:
- A profile encoder
- An event encoder
- A history encoder
The model predicts masked event value tokens during pre-training.
# Small preset model.
model = pragma_model("S", n_keys=len(tok.key_vocab), n_vals=len(tok.val_vocab))
model
For quick experiments, use pragma_learner, which builds a compact PRAGMAModel and wraps it in a fastai Learner.
learn = pragma_learner(dls, n_keys=len(tok.key_vocab), n_vals=len(tok.val_vocab))
# learn.fit(1)
Current implemented API
Data
-
DataSource- wraps a polars
LazyFrame - validates declared columns
- supports
from_df(...)andfrom_file(...) - handles categorical, continuous, signed continuous, textual, event-time, and lifelong/profile fields
- wraps a polars
-
Tokenizer- builds key/value vocabularies
- bucketizes numerical fields
- tokenizes text fields
- converts sources into key-value-time form
-
PRAGMADataset- combines profile and event sources
- fits/saves a tokenizer
- writes sharded parquet token data with
write_kv(...)
Dataloading
-
PRAGMADataLoader- streams parquet shards
- groups rows by entity
- packs variable-length records up to
max_tokens - optionally applies MLM masking
-
pragma_dl- convenience function returning a
DataLoader
- convenience function returning a
-
pragma_dls- convenience function returning fastai
DataLoaders
- convenience function returning fastai
Model
-
PRAGMAModel- profile encoder
- event encoder
- calendar/time embeddings
- history encoder
- MLM head
-
pragma_model- creates preset model sizes:
"S","M","L"
- creates preset model sizes:
-
pragma_learner- creates a fastai learner for masked-token pre-training
Planned additions
The following pieces are planned for future versions:
- A more polished public API, possibly including
SourceSchemaas a friendlier alias or replacement forDataSource - A
.dataloaders()convenience method directly onPRAGMADataset - A top-level
PRAGMA.load(size="S"|"M"|"L")model-loading API - Better README examples using tiny synthetic data that can run without downloading MovieLens
- A richer
show_batch()display for inspecting tokenized profile and event records - Embedding extraction APIs such as
model.embed(dataset)andmodel.embed_record(record) - Task-specific heads for classification, regression, recommendation, and retrieval
- LoRA fine-tuning utilities for adapting the backbone efficiently
- Linear probing helpers for evaluating frozen embeddings
- Save/load helpers for trained learners, heads, tokenizers, and model weights
- Optional text encoder integration for richer free-text fields
- More complete documentation of temporal features, calendar features, and lifelong events
- More tests and smoke-test notebooks covering data → tokenizer → shards → dataloader → model → learner
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fastpragma-0.0.3.tar.gz.
File metadata
- Download URL: fastpragma-0.0.3.tar.gz
- Upload date:
- Size: 24.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f72eac3963b05bc1b1c8ef69058458cfc1486110d9b6d8b949079f114b667ef4
|
|
| MD5 |
ebf222b74bc947962b4b6602c894c7fe
|
|
| BLAKE2b-256 |
36cf3080b50e7328e9958385061a9b4e639305a638681f91d0330e502ea76e35
|
File details
Details for the file fastpragma-0.0.3-py3-none-any.whl.
File metadata
- Download URL: fastpragma-0.0.3-py3-none-any.whl
- Upload date:
- Size: 23.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9553922cf5204469e7f98d2a8f93b8b602dbc3cdb2e1e00967a4c7e51ba85dab
|
|
| MD5 |
8531db83e1ce08822f8d064c5017de16
|
|
| BLAKE2b-256 |
12aa5461a347722b1bb54693e005e3c3552e803272b50d02ff8ad2d37fc7be39
|