Train a transformer model with the command line
Project description
What is sequifier?
Sequifier makes training and inference of powerful causal transformer models fast and trustworthy.
The process looks like this:
Value Proposition
Implementing a model from scratch takes time, and there are a surprising number of aspects to consider. The idea is: why not do it once, make it configurable, and then use the same implementation across domains and datasets.
This gives us a number of benefits:
- rapid prototyping
- configurable architecture
- trusted implementation (you can't create bugs inadvertedly)
- standardized logging
- native multi-gpu support (DDP and FSDP)
- native multi-core preprocessing
- scales to datasets larger than RAM
- hyperparameter search
- can be used for prediction, generation and embeddding on/of arbitrary sequences
The only requirement is having sequifier installed, and having input data in the right format.
The Six Commands
There are six standalone commands within sequifier: make, preprocess, train, infer, hyperparameter-search, and visualize-training.
make sets up a new sequifier project in a new folder, preprocess preprocesses the data from the input format into subsequences of a fixed length, train trains a model on the preprocessed data, infer generates outputs from data in the preprocessed format and outputs it in the initial input format, hyperparameter-search executes multiple training runs to find optimal configurations, and visualize-training parses training logs to generate interactive HTML plots of your loss curves.
There are documentation pages for each command, except make:
- preprocess documentation
- train documentation
- infer documentation
- hyperparameter-search documentation
- visualize-training documentation
Other Materials
To get the full auto-generated documentation, visit sequifier.com
If you want to first get a more specific understanding of the transformer architecture, have a look at the Wikipedia article.
If you want to see an end-to-end example on very simple synthetic data, check out this this notebook.
Structure of a Sequifier Project
Sequifier is designed with a specific folder structure in mind:
YOUR_PROJECT_NAME/
├── configs/
│ ├── preprocess.yaml
│ ├── train.yaml
│ └── infer.yaml
├── data/
│ └── (Place your CSV/Parquet files here)
├── outputs/
│ ├── embeddings(?)
│ ├── predictions(?)
│ ├── probabilities(?)
│ └── visualization/
└── logs/
The sequifier commands should typically be run in the project root.
Within YOUR_PROJECT_NAME, you can also add other folders for additional steps, such as notebooks or scripts for pre- or postprocessing, and analysis, visualizations or evals for files you generate in other, manual steps.
Data Transformations in Sequifier
Let's start with the data format expected by sequifier. The basic data format that is used as input to the library takes the following form:
| sequenceId | itemPosition | column1 | column2 | ... |
|---|---|---|---|---|
| 0 | 0 | "high" | 12.3 | ... |
| 0 | 1 | "high" | 10.2 | ... |
| ... | ... | ... | ... | ... |
| 1 | 0 | "medium" | 20.6 | ... |
| ... | ... | ... | ... | ... |
The two columns "sequenceId" and "itemPosition" have to be present, and then there must be at least one feature column. There can also be many feature columns, and these can be categorical or real valued.
Data of this input format can be transformed into the format that is used for model training and inference using sequifier preprocess, which takes this form:
| sequenceId | subsequenceId | startItemPosition | columnName | [Subsequence Length] | [Subsequence Length - 1] | ... | 0 |
|---|---|---|---|---|---|---|---|
| 0 | 0 | 0 | column1 | "high" | "high" | ... | "low" |
| 0 | 0 | 0 | column2 | 12.3 | 10.2 | ... | 14.9 |
| ... | ... | ... | ... | ... | ... | ... | ... |
| 1 | 0 | 15 | column1 | "medium" | "high" | ... | "medium" |
| 1 | 0 | 15 | column2 | 20.6 | 18.5 | ... | 21.6 |
| ... | ... | ... | ... | ... | ... | ... | ... |
On inference, the output is returned in the library input format, introduced first.
| sequenceId | itemPosition | column1 | column2 | ... |
|---|---|---|---|---|
| 0 | 963 | "medium" | 8.9 | ... |
| 0 | 964 | "low" | 6.3 | ... |
| ... | ... | ... | ... | ... |
| 1 | 732 | "medium" | 14.4 | ... |
| ... | ... | ... | ... | ... |
Complete Example of Training and Inferring a Transformer Model
Once you have your data in the input format described above, you can train a transformer model in a couple of steps on them.
- create a conda environment with python >=3.10 and <=3.13 activate and run
pip install sequifier
- To create the project folder with the config templates in the configs subfolder, run
sequifier make YOUR_PROJECT_NAME
- cd into the
YOUR_PROJECT_NAMEfolder, create adatafolder and add your data and adapt the config filepreprocess.yamlin the configs folder to take the path to the data - run
sequifier preprocess
- the preprocessing step outputs a metadata config at
configs/metadata_configs/[FILE NAME]. Adapt themetadata_config_pathparameter intrain.yamlandinfer.yamlto the pathconfigs/metadata_configs/[FILE NAME] - Adapt the config file
train.yamlto specify the transformer hyperparameters you want and run
sequifier train
- adapt
data_pathininfer.yamlto one of the files output in the preprocessing step - run
sequifier infer
- find your predictions at
[PROJECT ROOT]/outputs/predictions/sequifier-default-best-10-predictions.csv
Other Features
Embedding Model
While Sequifier's primary use case is training predictive or generative causal transformer models, it also supports the export of embedding models.
Configuration:
- Training: Set export_embedding_model: true in the training config.
- Inference: Set model_type: embedding in the inference config.
Technical Details: The generated embedding has dimensionality dim_model and consists of the final hidden state (activations) of the transformer's last layer corresponding to the last token in the sequence. Because the model is trained on a causal objective, this is a "forward-looking" embedding: it is optimized to compress the sequence history into a representation that maximizes information about the future state of the data.
Distributed Training
Sequifier supports distributed training using torch DistributedDataParallel and FullyShardedDataParallel. To make use of multi gpu support, the write format of the preprocessing step must be set to 'pt' and merge_output must be set to false in the preprocessing config.
For the full guide on how to configure a distributed run, check the training config README
System Requirements
Tiny transformer models on little data can be trained on CPU. Bigger ones require an Nvidia GPU with a compatible cuda version installed.
Sequifier currently runs on MacOS and Ubuntu.
Citation
Please cite with:
@software{sequifier_2025,
author = {Luithlen, Leon},
title = {sequifier - causal transformer models for multivariate sequence modelling},
year = {2025},
publisher = {GitHub},
version = {v1.1.1.4},
url = {https://github.com/0xideas/sequifier}
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
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 sequifier-1.1.1.4-py3-none-any.whl.
File metadata
- Download URL: sequifier-1.1.1.4-py3-none-any.whl
- Upload date:
- Size: 111.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fd5a5ab4cfe8ebf6f8cd4fe1f29b83d590201c7ebd2c72ab69cf870b446f3f45
|
|
| MD5 |
fecb4b0e17f8fd4b36c9804727c75e5c
|
|
| BLAKE2b-256 |
5546f64ba7d22aeabba8b04ef2892751c101c7afa333abfda3e43ad33509f9ec
|