Text Generation
Transformers
Safetensors
English
lfm3_ts
time-series
time-series-question-answering
anomaly-detection
multimodal
lfm3
liquid
chatts
custom_code
conversational
Instructions to use nardi/LFM3-TS with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use nardi/LFM3-TS with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="nardi/LFM3-TS", trust_remote_code=True) messages = [ {"role": "user", "content": "Who are you?"}, ] pipe(messages)# pip install -U transformers accelerate # Load model directly from transformers import AutoModelForCausalLM model = AutoModelForCausalLM.from_pretrained("nardi/LFM3-TS", trust_remote_code=True, device_map="auto") - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use nardi/LFM3-TS with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "nardi/LFM3-TS" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "nardi/LFM3-TS", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'Use Docker
docker model run hf.co/nardi/LFM3-TS
- SGLang
How to use nardi/LFM3-TS with SGLang:
Install from pip and serve model
# Install SGLang from pip: pip install sglang # Start the SGLang server: python3 -m sglang.launch_server \ --model-path "nardi/LFM3-TS" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "nardi/LFM3-TS", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'Use Docker images
docker run --gpus all \ --shm-size 32g \ -p 30000:30000 \ -v ~/.cache/huggingface:/root/.cache/huggingface \ --env "HF_TOKEN=<secret>" \ --ipc=host \ lmsysorg/sglang:latest \ python3 -m sglang.launch_server \ --model-path "nardi/LFM3-TS" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "nardi/LFM3-TS", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }' - Docker Model Runner
How to use nardi/LFM3-TS with Docker Model Runner:
docker model run hf.co/nardi/LFM3-TS
File size: 13,393 Bytes
8f94540 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | # Copyright 2026 The HuggingFace Team. All rights reserved.
# Copyright 2026 Nardi Xhepi.
#
# NOTICE OF CHANGES: this file is part of LFM3-TS. It is adapted from `transformers.models.lfm3_vl`
# (Hugging Face Transformers, Apache License 2.0) and was changed by Nardi Xhepi: the vision tower and image
# inputs are replaced by a time-series encoder and time-series inputs.
#
# The portions taken from Transformers remain available under the Apache License, Version 2.0; a copy is in
# LICENSES/Apache-2.0.txt. LFM3-TS as a whole is distributed under the LFM Open License v1.0: see LICENSE and
# NOTICE at the root of the repository.
#
# Unless required by applicable law or agreed to in writing, this software is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
"""Processor for LFM3-TS."""
import numpy as np
from transformers.feature_extraction_utils import BatchFeature
from transformers.processing_utils import ProcessorMixin
from .feature_extraction_lfm3_ts import Lfm3TsFeatureExtractor, Lfm3TsSeriesStats
TS_TOKEN = "<|ts|>"
# The LFM3 chat template renders `image`, `video` and `text` content parts; these add a `timeseries` part. Each pair is
# (anchor found in the LFM3 template, branch inserted before it).
_CHAT_TEMPLATE_PATCHES = (
(
'{%- elif content is mapping and content.get("type") == "text" -%}',
'{%- elif content is mapping and content.get("type") == "timeseries" -%}\n'
' {{- "' + TS_TOKEN + '" -}}\n ',
),
(
'{%- elif item is mapping and item.get("type") == "text" -%}',
'{%- elif item is mapping and item.get("type") == "timeseries" -%}\n'
' {%- set _ns.result = _ns.result + "' + TS_TOKEN + '" -%}\n ',
),
)
def add_timeseries_to_chat_template(chat_template: str) -> str:
"""Teaches an LFM3 chat template to render `{"type": "timeseries"}` content parts as the placeholder token."""
for anchor, branch in _CHAT_TEMPLATE_PATCHES:
if chat_template.count(anchor) != 1:
raise ValueError(f"Cannot add time series to this chat template: expected exactly one `{anchor}`.")
chat_template = chat_template.replace(anchor, branch + anchor)
return chat_template
def _is_array(item) -> bool:
return hasattr(item, "ndim") and hasattr(item, "shape")
def _flatten_timeseries(timeseries) -> list[np.ndarray]:
"""Flat list of items, one per placeholder: 1D series or 2D `(num_channels, length)` multivariate series."""
if _is_array(timeseries):
return [np.asarray(timeseries, dtype=np.float64)]
if not isinstance(timeseries, (list, tuple)):
raise ValueError(f"`timeseries` must be arrays or lists of numbers, got {type(timeseries)}.")
if len(timeseries) > 0 and all(isinstance(value, (int, float, np.number)) for value in timeseries):
return [np.asarray(timeseries, dtype=np.float64)]
return [item for nested in timeseries for item in _flatten_timeseries(nested)]
class Lfm3TsProcessor(ProcessorMixin):
r"""
Wraps an `Lfm3TsFeatureExtractor` and an LFM3 tokenizer.
Each `<|ts|>` in the text stands for one item of `timeseries`. The processor replaces it with the item's
normalization statistics in plain text, followed by as many `<|ts|>` tokens as the model will fill with features:
```text
[offset: 12.5000 | scale: 3.2000 | length: 256 | min: 4.1000 | max: 21.7000 | first: 9.8000 | last: 15.2000]<|ts|>...<|ts|>
```
The statistics keep the original values recoverable (the encoder only sees standardized values), and the
extremes and end points spare the model the arithmetic for the values most often asked about. A 2D item of
shape `(num_channels, length)` expands to one such block per channel, each on its own line.
Args:
feature_extractor (`Lfm3TsFeatureExtractor`):
The feature extractor.
tokenizer (`PreTrainedTokenizerBase`):
An LFM3 tokenizer holding the `<|ts|>` token.
chat_template (`str`, *optional*):
A chat template that renders `{"type": "timeseries"}` content parts as `<|ts|>`.
position_marker_every (`int`, *optional*, defaults to 0):
Writes the index of a time step, as text like `<64>`, before the token of the patch that starts there,
every this many time steps. Must
be a multiple of the patch size; 0 writes none.
value_ruler (`bool`, *optional*, defaults to `False`):
Also writes, in the statistics, the values that stand at -2, -1, 0, +1 and +2 in the standardized units
the encoder sees. A checkpoint keeps the setting it was trained with.
"""
def __init__(
self,
feature_extractor=None,
tokenizer=None,
chat_template=None,
position_marker_every: int = 0,
value_ruler: bool = False,
**kwargs,
):
if position_marker_every % feature_extractor.patch_size:
raise ValueError(
f"position_marker_every={position_marker_every} must be a multiple of the patch size "
f"{feature_extractor.patch_size}."
)
self.position_marker_every = position_marker_every
self.value_ruler = value_ruler
self.ts_token = getattr(tokenizer, "ts_token", TS_TOKEN)
self.ts_token_id = tokenizer.convert_tokens_to_ids(self.ts_token)
super().__init__(feature_extractor, tokenizer, chat_template=chat_template)
@classmethod
def from_text_pretrained(
cls,
pretrained_model_name_or_path: str = "LiquidAI/LFM3-1.7B",
patch_size: int = 8,
position_marker_every: int = 0,
value_ruler: bool = False,
**kwargs,
) -> "Lfm3TsProcessor":
"""Builds a processor from an LFM3 text checkpoint: its tokenizer gains the `<|ts|>` token and its chat
template a `timeseries` content part. `kwargs` go to the tokenizer's `from_pretrained`."""
from transformers import AutoTokenizer
tokenizer = AutoTokenizer.from_pretrained(
pretrained_model_name_or_path, extra_special_tokens={"ts_token": TS_TOKEN}, **kwargs
)
chat_template = add_timeseries_to_chat_template(tokenizer.chat_template)
tokenizer.chat_template = chat_template
return cls(
Lfm3TsFeatureExtractor(patch_size=patch_size),
tokenizer,
chat_template=chat_template,
position_marker_every=position_marker_every,
value_ruler=value_ruler,
)
def format_series(self, stats: Lfm3TsSeriesStats) -> str:
"""The text standing for one series: its statistics, then a start, per-patch and end placeholder."""
header = (
f"[offset: {stats.offset:.4f} | scale: {stats.scale:.4f} | length: {stats.length}"
f" | min: {stats.minimum:.4f} | max: {stats.maximum:.4f}"
f" | first: {stats.first:.4f} | last: {stats.last:.4f}"
)
if self.value_ruler:
marks = ", ".join(f"{level:+d}: {stats.offset + level * stats.scale:.4f}" for level in (-2, -1, 0, 1, 2))
header += f" | levels {marks}"
header += "]"
if not self.position_marker_every:
return header + self.ts_token * (stats.num_patches + 2)
patch_size = self.feature_extractor.patch_size
pieces = [header, self.ts_token]
for patch in range(stats.num_patches):
index = patch * patch_size
if patch and index % self.position_marker_every == 0:
pieces.append(f"<{index}>")
pieces.append(self.ts_token)
return "".join(pieces) + self.ts_token
def __call__(self, text=None, timeseries=None, return_tensors=None, **kwargs) -> BatchFeature:
"""
Args:
text (`str` or `list[str]`):
The prompts, with one `<|ts|>` per item of `timeseries`.
timeseries (*optional*):
A series, or a list of them (or one list per prompt), in the order of their placeholders. A 1D array
or list of numbers is one series; a 2D array of shape `(num_channels, length)` is a multivariate
series. NaN marks a missing value.
return_tensors (`str`, *optional*):
The tensor type to return, e.g. `"pt"`.
kwargs:
Passed to the tokenizer (`padding`, `truncation`, `add_special_tokens`, ...).
Returns:
`BatchFeature` with `input_ids`, `attention_mask` and, when `timeseries` is given, `input_values` and
`input_values_mask` of shape `(num_series, max_patches, patch_size)`.
"""
if text is None:
raise ValueError("You must provide `text`.")
prompts = [text] if isinstance(text, str) else list(text)
items = [] if timeseries is None else _flatten_timeseries(timeseries)
num_placeholders = sum(prompt.count(self.ts_token) for prompt in prompts)
if num_placeholders != len(items):
raise ValueError(
f"Found {num_placeholders} {self.ts_token} tokens in the text but received {len(items)} time series."
)
data = {}
if items:
channels, channels_per_item = [], []
for index, item in enumerate(items):
if item.ndim not in (1, 2):
raise ValueError(f"Time series {index} must be 1D or 2D (num_channels, length), got {item.shape}.")
item_channels = [item] if item.ndim == 1 else list(item)
channels.extend(item_channels)
channels_per_item.append(len(item_channels))
input_values, input_values_mask, stats = self.feature_extractor.preprocess(channels)
data.update(input_values=input_values, input_values_mask=input_values_mask)
blocks = iter(self.format_series(stat) for stat in stats)
replacements = iter("\n".join(next(blocks) for _ in range(count)) for count in channels_per_item)
expanded = []
for prompt in prompts:
pieces = prompt.split(self.ts_token)
expanded.append("".join(piece + next(replacements) for piece in pieces[:-1]) + pieces[-1])
prompts = expanded
text_inputs = self.tokenizer(prompts, **kwargs)
return BatchFeature(data={**text_inputs, **data}, tensor_type=return_tensors)
def apply_chat_template(
self,
conversation,
chat_template: str | None = None,
tokenize: bool = False,
return_dict: bool = True,
add_generation_prompt: bool = False,
**kwargs,
):
"""
Renders one conversation, or a batch of them, and optionally tokenizes it together with its time series.
A time series is a content part `{"type": "timeseries", "timeseries": array}`. Template arguments (`tools`,
`documents`, `continue_final_message`, `reasoning_effort`, `enable_thinking`, `preserve_thinking`) are
forwarded to the template; other `kwargs` go to `__call__` when `tokenize=True`.
"""
is_batched = isinstance(conversation, (list, tuple)) and isinstance(conversation[0], (list, tuple))
conversations = conversation if is_batched else [conversation]
timeseries, rendered_conversations = [], []
for messages in conversations:
rendered_messages = []
for message in messages:
content = message.get("content")
if isinstance(content, (list, tuple)):
parts = []
for part in content:
if isinstance(part, dict) and part.get("type") == "timeseries":
timeseries.append(part["timeseries"])
part = {"type": "timeseries"}
parts.append(part)
message = {**message, "content": parts}
rendered_messages.append(message)
rendered_conversations.append(rendered_messages)
template_keys = (
"tools",
"documents",
"continue_final_message",
"reasoning_effort",
"enable_thinking",
"preserve_thinking",
)
template_kwargs = {key: kwargs.pop(key) for key in template_keys if key in kwargs}
prompts = [
self.tokenizer.apply_chat_template(
messages,
chat_template=chat_template or self.chat_template,
tokenize=False,
add_generation_prompt=add_generation_prompt,
**template_kwargs,
)
for messages in rendered_conversations
]
if not tokenize:
return prompts if is_batched else prompts[0]
# the template writes the special tokens itself
kwargs.setdefault("add_special_tokens", False)
inputs = self(text=prompts, timeseries=timeseries or None, **kwargs)
return inputs if return_dict else inputs["input_ids"]
@property
def model_input_names(self):
names = self.tokenizer.model_input_names + self.feature_extractor.model_input_names
return list(dict.fromkeys(names))
__all__ = ["Lfm3TsProcessor", "add_timeseries_to_chat_template"]
|