Top-level API¶
This page covers the smallest public entrypoint surface of AnomaLog.
Start here when you want the library-level names that most examples import directly, rather than the lower-level building blocks under the submodules.
>>> from anomalog import DatasetSpec, SplitLabel
>>> DatasetSpec("demo").dataset_name
'demo'
>>> SplitLabel.TRAIN.value
'train'
anomalog¶
Top-level public API for AnomaLog.
DatasetSpec
dataclass
¶
Immutable fluent builder for configuring a dataset pipeline.
build()
¶
Build and return the templated dataset view.
Returns:
| Name | Type | Description |
|---|---|---|
TemplatedDataset |
TemplatedDataset
|
Built dataset with structured rows, labels, and templates attached. |
clear_cache()
¶
Delete all local cached artifacts for this dataset.
Raises:
| Type | Description |
|---|---|
ValueError
|
If the dataset name is empty. |
from_source(source)
¶
Return a copy configured with a dataset source.
label_with(anomaly_label_reader)
¶
Return a copy configured with an anomaly label reader.
parse_with(structured_parser)
¶
Return a copy configured with a structured parser.
store_with(structured_sink)
¶
Return a copy configured with a structured sink type.
template_with(template_parser)
¶
Return a copy configured with a template parser type.
with_cache_paths(cache_paths)
¶
Return a copy configured with explicit cache and data roots.