API Reference¶

Generated from the source docstrings. For narrative docs with examples, see the Guide and Reference sections; the pages here are the exhaustive symbol listing.

timenet¶

• timenet.builders — Builder discovery: how the SDK finds something able to build a dataset the registry lacks.
• timenet.client — The TimeNet class is the SDK's single entry point for using TimeNet from code.
• timenet.config — Runtime configuration, resolved with pydantic-settings.
• timenet.connectors — The connector contract: BaseConnector.
• timenet.dataset — The in-memory TimeF model a connector populates during convert().
• timenet.engine — The build engine: drive a connector through download -> convert -> derive_schema -> store.
• timenet.errors — TimeNet's exception hierarchy, and the warnings it raises.
• timenet.format — The TimeF on-disk format contract: filenames, layout templates, and pinned Arrow schemas.
• timenet.manifest — The dataset manifest: a frozen Manifest and its JSON codec.
• timenet.provenance — Describe the environment a build ran in, for the manifest's provenance block.
• timenet.reader — Deserialization of a TimeF version directory into a timenet.dataset.TimeFDataset.
• timenet.registry — Dataset registries: serve compiled TimeF versions and search over metadata.
• timenet.types — TimeF value types and type system: versions, units, enums, specs, annotations, tasks, metadata.
• timenet.values_backends — Values-plane storage backend contracts and built-in backend identifiers.
• timenet.writer — Serialization of a timenet.dataset.TimeFDataset to the TimeF on-disk format.

timenet_connectors¶

• timenet_connectors.api — Producer-side shortcuts to build and load a dataset from local code.
• timenet_connectors.bases — Reusable connector base classes.
• timenet_connectors.discovery — Discover connectors lazily by convention.
• timenet_connectors.download — Async, scheme-dispatching artifact downloads for connectors.