Skip to content

Commit 125ed0c

Browse files
authored
Merge pull request #794 from light-curve/fix/chronos-bolt-docs
fix(embed): fix ChronosBolt docs table and require explicit size
2 parents a4545fd + a2b03a2 commit 125ed0c

2 files changed

Lines changed: 9 additions & 13 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1313

1414
### Changed
1515

16-
--
16+
- **Experimental feature broken**: `light_curve.embed.ChronosBolt.from_hf()` now requires an
17+
explicit `size` argument instead of defaulting to `"base"`. The four sizes have different
18+
embedding dimensions, so a silent default was error-prone; callers must now pass e.g.
19+
`ChronosBolt.from_hf(size="base")`.
1720

1821
### Deprecated
1922

light-curve/light_curve/embed/chronos.py

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -263,15 +263,7 @@ class ChronosBolt(_ChronosModel):
263263
264264
A faster, patch-based Chronos variant available in four sizes with
265265
different embedding dimensions (native context up to 2048 observations):
266-
267-
===== =========
268-
size embed_dim
269-
===== =========
270-
tiny 256
271-
mini 384
272-
small 512
273-
base 768
274-
===== =========
266+
``tiny`` (256), ``mini`` (384), ``small`` (512), and ``base`` (768).
275267
276268
The ONNX models are hosted on HuggingFace at
277269
``https://huggingface.co/light-curve/chronos-bolt-<size>``.
@@ -331,7 +323,7 @@ def __init__(
331323
@classmethod
332324
def from_hf(
333325
cls,
334-
size: str = "base",
326+
size: str,
335327
output: str = "mean",
336328
*,
337329
reduction: str | list[str] | Reduction = "end",
@@ -342,8 +334,9 @@ def from_hf(
342334
343335
Parameters
344336
----------
345-
size : {"tiny", "mini", "small", "base"}, optional
346-
Model size to load. Defaults to ``"base"``.
337+
size : {"tiny", "mini", "small", "base"}
338+
Model size to load. Required: the sizes have different embedding
339+
dimensions, so there is no meaningful default.
347340
output : str, optional
348341
``"mean"`` (default) or ``"sequence"``.
349342
reduction : str, list of str, or Reduction, optional

0 commit comments

Comments
 (0)