Skip to main content

Ready-to-use time series models implemented in PyTorch and Lightning.

Project description

chronocratic-models

License: BSD-3-Clause PyPI version Python versions PyPI Downloads Build Status Documentation Status Code style: ruff GitHub stars

Ready-to-use time series models implemented in PyTorch and Lightning.

Note: The PyPI package name uses a hyphen (chronocratic-models), but the import uses the chronocratic.models namespace.

Installation

pip install chronocratic-models

Quick Start

import torch
from chronocratic.models import TS2Vec, TS2VecModelParameters

# Create model using parameters dataclass
params = TS2VecModelParameters(input_dims=1)
model = TS2Vec(**vars(params))

# Prepare synthetic time series (n_instance, n_timestamps, n_features)
synthetic_data = torch.randn(2, 100, 1)

# Get multi-scale representations
representations = model.encode(
    synthetic_data,
    batch_size=2,
    num_workers=0,
    encoding_window="multiscale",
)
print(representations.shape)

Models

Convolutional (Dilated)

Model Description
TS2Vec Multi-scale hierarchical representation learning via dilated convolutions with hierarchical clustering. Code source: zhihanyue/ts2vec
CoST Decomposition-based contrastive self-supervised learning with trend-seasonal decomposition and contrastive objectives. Code source: salesforce/CoST
AutoTCL Automatic temporal contrastive learning with a trainable augmentation module for self-supervised time-series encoding. Code source: AslanDing/AutoTCL

Convolutional (Standard)

Model Description
Series2Vec Self-supervised pretraining via contrastive learning on augmented time-series segments.
TSTCC Temporal and contextual contrastive pretraining for time-series representation learning.
FCN Fully convolutional encoder designed for Mixup Contrastive Learning (MCL) objectives.

Transformer

Model Description
TST Time Series Transformer with masked-reconstruction-based self-supervised pretraining.

Recurrent

Model Description
TimeNet Recurrent encoder-decoder architecture for time-series representation learning.

Generative

Model Description
TimeVAE Variational autoencoder for time-series data with latent representation encoding and generation.

Features

  • Polymorphic augmentation producer contract — models accept any augmentation through a unified interface, eliminating enum-based branching.
  • Lightning integration — all models are built on PyTorch Lightning for clean training loops and extensibility.
  • Self-supervised representation learning — pre-trained encoders ready for downstream tasks without labeled data.
  • Pre-configured model parameters — each model ships with tested default configuration dataclasses.
  • NumPy and PyTorch tensor support — flexible input handling for both frameworks.

Documentation

For full API reference, guides, and examples, visit chronocratic-models.readthedocs.io.

License

This project is licensed under the BSD 3-Clause License — see the LICENSE file for details.

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

chronocratic_models-0.1.0a3.tar.gz (283.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chronocratic_models-0.1.0a3-py3-none-any.whl (118.7 kB view details)

Uploaded Python 3

File details

Details for the file chronocratic_models-0.1.0a3.tar.gz.

File metadata

  • Download URL: chronocratic_models-0.1.0a3.tar.gz
  • Upload date:
  • Size: 283.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for chronocratic_models-0.1.0a3.tar.gz
Algorithm Hash digest
SHA256 e7479d7faf127925353c4b1ce356f8f97c38a77eb71d395c3c00c9568085893b
MD5 ca96070a0e66c3f24ed802d71dd8f964
BLAKE2b-256 d292c1fd4e7b395e7606398534a1dd62fbe4fd16f7f9c50bde9eb0da68e39ed1

See more details on using hashes here.

Provenance

The following attestation bundles were made for chronocratic_models-0.1.0a3.tar.gz:

Publisher: pypi-publish.yml on chronocratic/chronocratic-models

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file chronocratic_models-0.1.0a3-py3-none-any.whl.

File metadata

File hashes

Hashes for chronocratic_models-0.1.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 b6eac44a0e0532f3b640d7eba0fde80b5856c3125c2b4e9961fff17ba4813784
MD5 0d856618d5039e1b4e00bd20d4dd9da0
BLAKE2b-256 b6ac048f9d7525a09063c7b932a74ae171dca034f6ea0ba3f7d1768cde69f236

See more details on using hashes here.

Provenance

The following attestation bundles were made for chronocratic_models-0.1.0a3-py3-none-any.whl:

Publisher: pypi-publish.yml on chronocratic/chronocratic-models

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page