# Python API catalog

Search classes and functions by name or module. Documentation is generated from the Python source without importing training dependencies.

- [stage_baseline](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/artifacts/baselines/#sleepkit.artifacts.baselines.stage_baseline): Package a pinned historical TFLite baseline without conversion or retraining. — kind: function — category: artifacts
- [main](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/artifacts/cli/#sleepkit.artifacts.cli.main): kind: function — category: artifacts
- [publish_bundle](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/artifacts/hub/#sleepkit.artifacts.hub.publish_bundle): Dry run by default. Upload a validated snapshot without loading a model. — kind: function — category: artifacts
- [download_bundle](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/artifacts/hub/#sleepkit.artifacts.hub.download_bundle): Download an explicitly selected revision and validate its artifact inventory. — kind: function — category: artifacts
- [write_json](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/artifacts/package/#sleepkit.artifacts.package.write_json): kind: function — category: artifacts
- [stage_bundle](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/artifacts/package/#sleepkit.artifacts.package.stage_bundle): Copy an explicit artifact list into an immutable directory atomically. — kind: function — category: artifacts
- [validate_bundle](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/artifacts/package/#sleepkit.artifacts.package.validate_bundle): Verify structure/integrity and optional persisted runtime evidence. — kind: function — category: artifacts
- [stage_release](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/artifacts/release/#sleepkit.artifacts.release.stage_release): Preserve model bytes/evidence and add caller-selected release documentation. — kind: function — category: artifacts
- [create_reference](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/artifacts/runtime/#sleepkit.artifacts.runtime.create_reference): Record deterministic synthetic I/O. This establishes no task accuracy. — kind: function — category: artifacts
- [replay_bundle](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/artifacts/runtime/#sleepkit.artifacts.runtime.replay_bundle): Replay every declared model against its recorded, hash-bound synthetic I/O. — kind: function — category: artifacts
- [filename](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/artifacts/schema/#sleepkit.artifacts.schema.filename): kind: function — category: artifacts
- [TensorSpec](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/artifacts/schema/#sleepkit.artifacts.schema.TensorSpec): `dataclass` — kind: class — category: artifacts
- [Artifact](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/artifacts/schema/#sleepkit.artifacts.schema.Artifact): `dataclass` — kind: class — category: artifacts
- [Check](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/artifacts/schema/#sleepkit.artifacts.schema.Check): `dataclass` — kind: class — category: artifacts
- [InferenceBackend](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/backend/#sleepkit.backends.backend.InferenceBackend): Backend inference engine base class — kind: class — category: backends
- [Reference](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/#sleepkit.backends.erpc.Reference): Simple container class used for pass by reference. — kind: class — category: backends
- [ClientInfo](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/arbitrator/#sleepkit.backends.erpc.arbitrator.ClientInfo): kind: class — category: backends
- [TransportArbitrator](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/arbitrator/#sleepkit.backends.erpc.arbitrator.TransportArbitrator): Shares a transport between a server and multiple clients. — kind: class — category: backends
- [BasicCodec](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/basic_codec/#sleepkit.backends.erpc.basic_codec.BasicCodec): Version of this codec. — kind: class — category: backends
- [RequestError](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/client/#sleepkit.backends.erpc.client.RequestError): kind: class — category: backends
- [ClientManager](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/client/#sleepkit.backends.erpc.client.ClientManager): kind: class — category: backends
- [RequestContext](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/client/#sleepkit.backends.erpc.client.RequestContext): kind: class — category: backends
- [MessageType](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/codec/#sleepkit.backends.erpc.codec.MessageType): kind: class — category: backends
- [CodecError](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/codec/#sleepkit.backends.erpc.codec.CodecError): kind: class — category: backends
- [Codec](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/codec/#sleepkit.backends.erpc.codec.Codec): kind: class — category: backends
- [Crc16](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/crc16/#sleepkit.backends.erpc.crc16.Crc16): kind: class — category: backends
- [Service](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/server/#sleepkit.backends.erpc.server.Service): kind: class — category: backends
- [Server](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/server/#sleepkit.backends.erpc.server.Server): kind: class — category: backends
- [SimpleServer](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/simple_server/#sleepkit.backends.erpc.simple_server.SimpleServer): kind: class — category: backends
- [ServerThread](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/simple_server/#sleepkit.backends.erpc.simple_server.ServerThread): kind: class — category: backends
- [Transport](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/transport/#sleepkit.backends.erpc.transport.Transport): Base transport class. — kind: class — category: backends
- [FramedTransport](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/transport/#sleepkit.backends.erpc.transport.FramedTransport): kind: class — category: backends
- [SerialTransport](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/transport/#sleepkit.backends.erpc.transport.SerialTransport): kind: class — category: backends
- [ConnectionClosed](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/transport/#sleepkit.backends.erpc.transport.ConnectionClosed): kind: class — category: backends
- [TCPTransport](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/transport/#sleepkit.backends.erpc.transport.TCPTransport): kind: class — category: backends
- [RpmsgTransport](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/transport/#sleepkit.backends.erpc.transport.RpmsgTransport): kind: class — category: backends
- [LIBUSBSIOSPITransport](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/transport/#sleepkit.backends.erpc.transport.LIBUSBSIOSPITransport): kind: class — category: backends
- [LIBUSBSIOI2CTransport](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/erpc/transport/#sleepkit.backends.erpc.transport.LIBUSBSIOI2CTransport): kind: class — category: backends
- [RpcCommands](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/evb/#sleepkit.backends.evb.RpcCommands): RPC commands — kind: class — category: backends
- [EvbBackend](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/evb/#sleepkit.backends.evb.EvbBackend): EVB inference engine backend — kind: class — category: backends
- [evb_to_pcClient](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/genericdataoperations_evbtopc/client/#sleepkit.backends.GenericDataOperations_EvbToPc.client.evb_to_pcClient): kind: class — category: backends
- [status](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/genericdataoperations_evbtopc/common/#sleepkit.backends.GenericDataOperations_EvbToPc.common.status): kind: class — category: backends
- [dataType](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/genericdataoperations_evbtopc/common/#sleepkit.backends.GenericDataOperations_EvbToPc.common.dataType): kind: class — category: backends
- [command](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/genericdataoperations_evbtopc/common/#sleepkit.backends.GenericDataOperations_EvbToPc.common.command): kind: class — category: backends
- [dataBlock](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/genericdataoperations_evbtopc/common/#sleepkit.backends.GenericDataOperations_EvbToPc.common.dataBlock): kind: class — category: backends
- [Ievb_to_pc](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/genericdataoperations_evbtopc/interface/#sleepkit.backends.GenericDataOperations_EvbToPc.interface.Ievb_to_pc): kind: class — category: backends
- [evb_to_pcService](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/genericdataoperations_evbtopc/server/#sleepkit.backends.GenericDataOperations_EvbToPc.server.evb_to_pcService): kind: class — category: backends
- [pc_to_evbClient](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/genericdataoperations_pctoevb/client/#sleepkit.backends.GenericDataOperations_PcToEvb.client.pc_to_evbClient): kind: class — category: backends
- [status](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/genericdataoperations_pctoevb/common/#sleepkit.backends.GenericDataOperations_PcToEvb.common.status): kind: class — category: backends
- [dataType](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/genericdataoperations_pctoevb/common/#sleepkit.backends.GenericDataOperations_PcToEvb.common.dataType): kind: class — category: backends
- [command](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/genericdataoperations_pctoevb/common/#sleepkit.backends.GenericDataOperations_PcToEvb.common.command): kind: class — category: backends
- [dataBlock](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/genericdataoperations_pctoevb/common/#sleepkit.backends.GenericDataOperations_PcToEvb.common.dataBlock): kind: class — category: backends
- [Ipc_to_evb](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/genericdataoperations_pctoevb/interface/#sleepkit.backends.GenericDataOperations_PcToEvb.interface.Ipc_to_evb): kind: class — category: backends
- [pc_to_evbService](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/genericdataoperations_pctoevb/server/#sleepkit.backends.GenericDataOperations_PcToEvb.server.pc_to_evbService): kind: class — category: backends
- [PcBackend](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/pc/#sleepkit.backends.pc.PcBackend): PC inference engine backend. — kind: class — category: backends
- [get_serial_transport](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/backends/utils/#sleepkit.backends.utils.get_serial_transport): Create serial transport. Scans looking for port matching criteria. — kind: function — category: backends
- [parse_content](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/cli/#sleepkit.cli.parse_content): Parse file or raw content into Pydantic model. — kind: function — category: cli
- [run](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/cli/#sleepkit.cli.run): sleepKIT CLI — kind: function — category: cli
- [main](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/cli/#sleepkit.cli.main): kind: function — category: cli
- [create_augmentation_layer](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/augmentation/#sleepkit.datasets.augmentation.create_augmentation_layer): Create an augmentation layer from a configuration — kind: function — category: datasets
- [create_augmentation_pipeline](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/augmentation/#sleepkit.datasets.augmentation.create_augmentation_pipeline): Create an augmentation pipeline from a list of augmentation configurations. — kind: function — category: datasets
- [CmidssSleepStage](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/cmidss/#sleepkit.datasets.cmidss.CmidssSleepStage): CMIDSS sleep stages — kind: class — category: datasets
- [CmidssDataset](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/cmidss/#sleepkit.datasets.cmidss.CmidssDataset): CMIDSS dataset — kind: class — category: datasets
- [Dataset](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/dataset/#sleepkit.datasets.dataset.Dataset): Dataset serves as a base class to download and provide unified access to datasets. — kind: class — category: datasets
- [MesaSleepStage](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/mesa/#sleepkit.datasets.mesa.MesaSleepStage): MESA sleep stages — kind: class — category: datasets
- [MesaDataset](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/mesa/#sleepkit.datasets.mesa.MesaDataset): MESA dataset — kind: class — category: datasets
- [download_file](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/nsrr/#sleepkit.datasets.nsrr.download_file): Download file from supplied url to destination streaming. — kind: function — category: datasets
- [authenticate_nsrr](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/nsrr/#sleepkit.datasets.nsrr.authenticate_nsrr): Authenticate the \[NSRR\](https://sleepdata.org) download token. — kind: function — category: datasets
- [list_nsrr_items](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/nsrr/#sleepkit.datasets.nsrr.list_nsrr_items): Recursively list items for a dataset to be downloaded. — kind: function — category: datasets
- [download_nsrr_file](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/nsrr/#sleepkit.datasets.nsrr.download_nsrr_file): Download a file from `url` to `dst` and verify `checksum`. — kind: function — category: datasets
- [download_nsrr](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/nsrr/#sleepkit.datasets.nsrr.download_nsrr): Recursively download files from \[NSRR\](https://sleepdata.org). — kind: function — category: datasets
- [StagesSleepStage](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/stages/#sleepkit.datasets.stages.StagesSleepStage): Sleep stage enum — kind: class — category: datasets
- [StagesDataset](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/stages/#sleepkit.datasets.stages.StagesDataset): STAGES dataset — kind: class — category: datasets
- [YsywSleepStage](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/ysyw/#sleepkit.datasets.ysyw.YsywSleepStage): YSYW sleep stages — kind: class — category: datasets
- [YsywDataset](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/datasets/ysyw/#sleepkit.datasets.ysyw.YsywDataset): YSYW dataset — kind: class — category: datasets
- [NamedParams](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/defines/#sleepkit.defines.NamedParams): Named parameters is used to store parameters for a specific model, preprocessing, or augmentation. — kind: class — category: defines
- [TaskMode](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/defines/#sleepkit.defines.TaskMode): Task run mode — kind: class — category: defines
- [QuantizationParams](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/defines/#sleepkit.defines.QuantizationParams): Quantization parameters — kind: class — category: defines
- [FeatureParams](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/defines/#sleepkit.defines.FeatureParams): Feature configuration params — kind: class — category: defines
- [TaskParams](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/defines/#sleepkit.defines.TaskParams): Task configuration params — kind: class — category: defines
- [SleepApnea](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/defines/#sleepkit.defines.SleepApnea): Sleep apnea class — kind: class — category: defines
- [SleepStage](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/defines/#sleepkit.defines.SleepStage): Sleep stage class — kind: class — category: defines
- [FeatureSet](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/features/featureset/#sleepkit.features.featureset.FeatureSet): Feature set abstract class. — kind: class — category: features
- [FS_C_EAR_9](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/features/fs_c_ear_9/#sleepkit.features.fs_c_ear_9.FS_C_EAR_9): Feature set: FS-C-EAR-9 — kind: class — category: features
- [FS_H_E_10](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/features/fs_h_e_10/#sleepkit.features.fs_h_e_10.FS_H_E_10): Feature set: FS-H-E-10 — kind: class — category: features
- [FS_W_A_5](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/features/fs_w_a_5/#sleepkit.features.fs_w_a_5.FS_W_A_5): Feature set: FS-W-A-5 — kind: class — category: features
- [FS_W_P_40](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/features/fs_w_p_40/#sleepkit.features.fs_w_p_40.FS_W_P_40): Feature set: FS-W-P-40 — kind: class — category: features
- [FS_W_P_5](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/features/fs_w_p_5/#sleepkit.features.fs_w_p_5.FS_W_P_5): Feature set: FS-W-P-5 — kind: class — category: features
- [FS_W_PA_14](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/features/fs_w_pa_14/#sleepkit.features.fs_w_pa_14.FS_W_PA_14): Feature set: FS-W-PA-14 — kind: class — category: features
- [H5Dataloader](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/features/h5dataloader/#sleepkit.features.h5dataloader.H5Dataloader): Dataloader to load features from folder containing HDF5 files. — kind: class — category: features
- [ModelFactoryItem](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/models/#sleepkit.models.ModelFactoryItem): kind: class — category: models
- [verify](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/alignment/#sleepkit.recipes.detection.alignment.verify): Read all samples and optionally check event clocks, not annotation semantics. — kind: function — category: recipes
- [main](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/alignment/#sleepkit.recipes.detection.alignment.main): kind: function — category: recipes
- [load_events](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/audit/#sleepkit.recipes.detection.audit.load_events): Retain every row so missing/duplicate event pairs cannot disappear silently. — kind: function — category: recipes
- [inspect_nights](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/audit/#sleepkit.recipes.detection.audit.inspect_nights): Return unambiguous paired sleep candidates in source-step coordinates. — kind: function — category: recipes
- [compare_labels](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/audit/#sleepkit.recipes.detection.audit.compare_labels): kind: function — category: recipes
- [inspect_clock](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/audit/#sleepkit.recipes.detection.audit.inspect_clock): Report local-clock discontinuities; do not infer physical sample gaps. — kind: function — category: recipes
- [audit](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/audit/#sleepkit.recipes.detection.audit.audit): Inspect local source labels without opening files for writing or training a model. — kind: function — category: recipes
- [main](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/audit/#sleepkit.recipes.detection.audit.main): kind: function — category: recipes
- [collect_calibration](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/calibration/#sleepkit.recipes.detection.calibration.collect_calibration): Collect frozen-normalizer model inputs from native train contexts. — kind: function — category: recipes
- [context_counts](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/candidate_audit/#sleepkit.recipes.detection.candidate_audit.context_counts): Count native complete contexts without compacting invalid or unknown frames. — kind: function — category: recipes
- [audit](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/candidate_audit/#sleepkit.recipes.detection.candidate_audit.audit): Count candidate coverage using unchanged originals bound to trusted local evidence. — kind: function — category: recipes
- [main](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/candidate_audit/#sleepkit.recipes.detection.candidate_audit.main): kind: function — category: recipes
- [CandidateLabels](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/candidate_labels/#sleepkit.recipes.detection.candidate_labels.CandidateLabels): `dataclass` — kind: class — category: recipes
- [build_candidates](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/candidate_labels/#sleepkit.recipes.detection.candidate_labels.build_candidates): Build candidates from one series' raw CSV groups and independently verified clock. — kind: function — category: recipes
- [materialize](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/clock_source/#sleepkit.recipes.detection.clock_source.materialize): Return provenance after atomically creating a new clock-bearing source folder. — kind: function — category: recipes
- [main](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/clock_source/#sleepkit.recipes.detection.clock_source.main): kind: function — category: recipes
- [class_metrics](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/comparison/#sleepkit.recipes.detection.comparison.class_metrics): Fixed two-class descriptive metrics; no probability interpretation. — kind: function — category: recipes
- [match_context](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/comparison/#sleepkit.recipes.detection.comparison.match_context): Reject coordinate or target drift even when shapes and timestamps look plausible. — kind: function — category: recipes
- [compare](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/comparison/#sleepkit.recipes.detection.comparison.compare): Run one declared descriptive comparison; output is exclusively local evidence. — kind: function — category: recipes
- [Recording](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/data/#sleepkit.recipes.detection.data.Recording): `dataclass` — kind: class — category: recipes
- [read_subject](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/data/#sleepkit.recipes.detection.data.read_subject): Legacy two-array interface; use read_recording to retain the independent clock. — kind: function — category: recipes
- [read_recording](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/data/#sleepkit.recipes.detection.data.read_recording): kind: function — category: recipes
- [load_split](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/data/#sleepkit.recipes.detection.data.load_split): kind: function — category: recipes
- [subject_features](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/data/#sleepkit.recipes.detection.data.subject_features): kind: function — category: recipes
- [examples](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/data/#sleepkit.recipes.detection.data.examples): kind: function — category: recipes
- [analyze](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/error_analysis/#sleepkit.recipes.detection.error_analysis.analyze): Exclusively write local diagnostics, retaining series IDs only in the file. — kind: function — category: recipes
- [main](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/error_analysis/#sleepkit.recipes.detection.error_analysis.main): kind: function — category: recipes
- [read_bound_json](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/evaluation/#sleepkit.recipes.detection.evaluation.read_bound_json): Parse the same bytes whose digest was verified, including transient changes. — kind: function — category: recipes
- [summarize](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/evaluation/#sleepkit.recipes.detection.evaluation.summarize): Verify local run evidence and exclusively write a per-series JSON report. — kind: function — category: recipes
- [main](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/evaluation/#sleepkit.recipes.detection.evaluation.main): kind: function — category: recipes
- [export_bundle](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/export/#sleepkit.recipes.detection.export.export_bundle): kind: function — category: recipes
- [require_self_contained](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/hdf5/#sleepkit.recipes.detection.hdf5.require_self_contained): Reject indirect storage while allowing ordinary internal hard links. — kind: function — category: recipes
- [reconstruct_legacy_features](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/historical/#sleepkit.recipes.detection.historical.reconstruct_legacy_features): Reconstruct FS-W-A-5 features without reading historical labels. — kind: function — category: recipes
- [read_verified_features](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/historical/#sleepkit.recipes.detection.historical.read_verified_features): Read and verify legacy features, then apply whole-record normalization. — kind: function — category: recipes
- [SD2Runtime](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/historical/#sleepkit.recipes.detection.historical.SD2Runtime): Lazy LiteRT runtime pinned to the reviewed SD-2-TCN-SM model bytes. — kind: class — category: recipes
- [predict](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/inference/#sleepkit.recipes.detection.inference.predict): kind: function — category: recipes
- [build_model](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/model/#sleepkit.recipes.detection.model.build_model): kind: function — category: recipes
- [output_contract](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/output_contract/#sleepkit.recipes.detection.output_contract.output_contract): kind: function — category: recipes
- [validate_output](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/output_contract/#sleepkit.recipes.detection.output_contract.validate_output): kind: function — category: recipes
- [validate_input](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/preprocessing/#sleepkit.recipes.detection.preprocessing.validate_input): Validate source clocks before any cache access; clocks are never inferred from row indices. — kind: function — category: recipes
- [fingerprint](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/preprocessing/#sleepkit.recipes.detection.preprocessing.fingerprint): kind: function — category: recipes
- [Features](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/preprocessing/#sleepkit.recipes.detection.preprocessing.Features): `dataclass` — kind: class — category: recipes
- [extract](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/preprocessing/#sleepkit.recipes.detection.preprocessing.extract): Read aligned samples, using an optional independent source UTC clock for cadence. — kind: function — category: recipes
- [prepare](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/preprocessing/#sleepkit.recipes.detection.preprocessing.prepare): Cache stateless features only: annotations and normalization never enter the key. — kind: function — category: recipes
- [Normalizer](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/preprocessing/#sleepkit.recipes.detection.preprocessing.Normalizer): `dataclass` — kind: class — category: recipes
- [contexts](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/preprocessing/#sleepkit.recipes.detection.preprocessing.contexts): Yield complete nonoverlapping model contexts, never bridge dropped frames. — kind: function — category: recipes
- [profile_membership](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/profile/#sleepkit.recipes.detection.profile.profile_membership): Profile training only, keeping the reader's integrity checks and finite schedule. — kind: function — category: recipes
- [main](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/profile/#sleepkit.recipes.detection.profile.main): kind: function — category: recipes
- [inspect_integer_graph](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/quantization/#sleepkit.recipes.detection.quantization.inspect_integer_graph): Inspect every FlatBuffer subgraph tensor; integer I/O alone is insufficient. — kind: function — category: recipes
- [evaluate_quantized](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/quantization/#sleepkit.recipes.detection.quantization.evaluate_quantized): Replay and match the frozen test index; conversion is already fixed. — kind: function — category: recipes
- [verified_calibration](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/quantization/#sleepkit.recipes.detection.quantization.verified_calibration): Use the exact persisted calibration array whose hash is declared publicly. — kind: function — category: recipes
- [quantize_run](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/quantization/#sleepkit.recipes.detection.quantization.quantize_run): One fixed train-only calibration, conversion and evaluation; no tuning loop. — kind: function — category: recipes
- [Config](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/recipe/#sleepkit.recipes.detection.recipe.Config): `dataclass` — kind: class — category: recipes
- [dataset](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/recipe/#sleepkit.recipes.detection.recipe.dataset): kind: function — category: recipes
- [training_model](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/recipe/#sleepkit.recipes.detection.recipe.training_model): Build and compile the recipe's logits model; usable without running the pipeline. — kind: function — category: recipes
- [evaluate](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/recipe/#sleepkit.recipes.detection.recipe.evaluate): kind: function — category: recipes
- [run](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/recipe/#sleepkit.recipes.detection.recipe.run): Historical-label recipe, preserved for existing experiments. — kind: function — category: recipes
- [run_membership](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/recipe/#sleepkit.recipes.detection.recipe.run_membership): Compose an AnnotatedDataset with training, evaluation, and versioned export. — kind: function — category: recipes
- [DetectionRuntime](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/runtime/#sleepkit.recipes.detection.runtime.DetectionRuntime): One context in, float32 logits out; never applies a softmax. — kind: class — category: recipes
- [write_index](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/scoring/#sleepkit.recipes.detection.scoring.write_index): Write JSONL in evaluation order without retaining a dataset-wide row list. — kind: function — category: recipes
- [make_fixture](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/smoke/#sleepkit.recipes.detection.smoke.make_fixture): kind: function — category: recipes
- [run_smoke](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/smoke/#sleepkit.recipes.detection.smoke.run_smoke): kind: function — category: recipes
- [assign](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/split/#sleepkit.recipes.detection.split.assign): Hash-rank all groups, independent of input ordering, labels, and model scores. — kind: function — category: recipes
- [freeze](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/split/#sleepkit.recipes.detection.split.freeze): Freeze all audited subjects; coverage summarizes an already assigned split. — kind: function — category: recipes
- [main](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/split/#sleepkit.recipes.detection.split.main): kind: function — category: recipes
- [AnnotatedDataset](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/detection/target_dataset/#sleepkit.recipes.detection.target_dataset.AnnotatedDataset): Small source adapter; callers retain control of training and orchestration. — kind: class — category: recipes
- [Config](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/signals/recipe/#sleepkit.recipes.signals.recipe.Config): `dataclass` — kind: class — category: recipes
- [make_data](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/signals/recipe/#sleepkit.recipes.signals.recipe.make_data): Create deterministic train/validation/test raw waveforms and integer targets. — kind: function — category: recipes
- [prepare](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/signals/recipe/#sleepkit.recipes.signals.recipe.prepare): Convert finite \[examples, 128\] waveforms into deterministic \[examples, 128, 1\] features. — kind: function — category: recipes
- [build_model](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/signals/recipe/#sleepkit.recipes.signals.recipe.build_model): Build the Keras model while using heliaEDGE's registered PatchLayer2D. — kind: function — category: recipes
- [train](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/signals/recipe/#sleepkit.recipes.signals.recipe.train): Train finite epochs with retained tail batches and return ``(model, history)``. — kind: function — category: recipes
- [evaluate](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/signals/recipe/#sleepkit.recipes.signals.recipe.evaluate): Evaluate one split with the shared unweighted classification accumulator. — kind: function — category: recipes
- [package](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/signals/recipe/#sleepkit.recipes.signals.recipe.package): Save model, metrics, config, and reload vectors into an archive-profile bundle. — kind: function — category: recipes
- [run](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/signals/recipe/#sleepkit.recipes.signals.recipe.run): Generate, train, evaluate, and package one synthetic recipe run. — kind: function — category: recipes
- [PreparedPartition](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/data/#sleepkit.recipes.staging.data.PreparedPartition): `dataclass` — kind: class — category: recipes
- [prepare_partition](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/data/#sleepkit.recipes.staging.data.prepare_partition): Preserve each record's context; omit only windows with no scored epochs. — kind: function — category: recipes
- [read_cohort](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/evaluation/#sleepkit.recipes.staging.evaluation.read_cohort): Read an explicit JSON list of unique filename stems, independent of discovery order. — kind: function — category: recipes
- [validate_model](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/evaluation/#sleepkit.recipes.staging.evaluation.validate_model): Require the saved SS-3-TCN-SM float32 sequence-to-logits interface. — kind: function — category: recipes
- [evaluate_windows](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/evaluation/#sleepkit.recipes.staging.evaluation.evaluate_windows): Apply the scoring mask after inference so excluded epochs retain context. — kind: function — category: recipes
- [evaluate](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/evaluation/#sleepkit.recipes.staging.evaluation.evaluate): Write an aggregate report only after evaluation and input revalidation. — kind: function — category: recipes
- [main](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/evaluation/#sleepkit.recipes.staging.evaluation.main): kind: function — category: recipes
- [build_model](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/model/#sleepkit.recipes.staging.model.build_model): kind: function — category: recipes
- [SubjectRecord](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/preprocessing/#sleepkit.recipes.staging.preprocessing.SubjectRecord): `dataclass` — kind: class — category: recipes
- [PreparedRecord](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/preprocessing/#sleepkit.recipes.staging.preprocessing.PreparedRecord): `dataclass` — kind: class — category: recipes
- [WindowedRecord](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/preprocessing/#sleepkit.recipes.staging.preprocessing.WindowedRecord): `dataclass` — kind: class — category: recipes
- [read_subject](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/preprocessing/#sleepkit.recipes.staging.preprocessing.read_subject): Read three self-contained HDF5 datasets and validate their schema. — kind: function — category: recipes
- [prepare_subject](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/preprocessing/#sleepkit.recipes.staging.preprocessing.prepare_subject): Copy, map labels, impute invalid rows, and normalize the complete record. — kind: function — category: recipes
- [window_subject](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/preprocessing/#sleepkit.recipes.staging.preprocessing.window_subject): Return nonoverlapping 240-epoch windows without stitching gaps or records. — kind: function — category: recipes
- [Config](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/recipe/#sleepkit.recipes.staging.recipe.Config): `dataclass` — kind: class — category: recipes
- [environment](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/recipe/#sleepkit.recipes.staging.recipe.environment): kind: function — category: recipes
- [revision](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/recipe/#sleepkit.recipes.staging.recipe.revision): Best-effort checkout identity; implementation hashes remain authoritative. — kind: function — category: recipes
- [train](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/recipe/#sleepkit.recipes.staging.recipe.train): Fit every supervised context once per epoch using Keras array adapters. — kind: function — category: recipes
- [evaluate](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/recipe/#sleepkit.recipes.staging.recipe.evaluate): Pooled scored-epoch metrics; unlike Keras history, not averaged batch means. — kind: function — category: recipes
- [declare_golden](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/recipe/#sleepkit.recipes.staging.recipe.declare_golden): Freeze prospective identities/configuration without training or reading labels. — kind: function — category: recipes
- [run](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/recipe/#sleepkit.recipes.staging.recipe.run): Declare, prepare, train, evaluate and archive one fixed-model experiment. — kind: function — category: recipes
- [fingerprint](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/split/#sleepkit.recipes.staging.split.fingerprint): kind: function — category: recipes
- [read_json](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/split/#sleepkit.recipes.staging.split.read_json): kind: function — category: recipes
- [validate_split](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/split/#sleepkit.recipes.staging.split.validate_split): Return a normalized copy; filename stems are caller-declared subject identities. — kind: function — category: recipes
- [load_split](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/split/#sleepkit.recipes.staging.split.load_split): kind: function — category: recipes
- [create_split](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/recipes/staging/split/#sleepkit.recipes.staging.split.create_split): Split an explicit cohort deterministically, before reading features or labels. — kind: function — category: recipes
- [ApneaTask](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/apnea/#sleepkit.tasks.apnea.ApneaTask): Sleep Apnea Task — kind: class — category: tasks
- [get_apnea_color_map](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/apnea/demo/#sleepkit.tasks.apnea.demo.get_apnea_color_map): Get color map for apnea classes — kind: function — category: tasks
- [demo](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/apnea/demo/#sleepkit.tasks.apnea.demo.demo): Sleep Apnea Demo — kind: function — category: tasks
- [evaluate](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/apnea/evaluate/#sleepkit.tasks.apnea.evaluate.evaluate): Evaluate sleep apnea model. — kind: function — category: tasks
- [export](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/apnea/export/#sleepkit.tasks.apnea.export.export): Export sleep apnea model. — kind: function — category: tasks
- [compute_sleep_apnea_durations](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/apnea/metrics/#sleepkit.tasks.apnea.metrics.compute_sleep_apnea_durations): Compute sleep apnea durations — kind: function — category: tasks
- [compute_apnea_efficiency](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/apnea/metrics/#sleepkit.tasks.apnea.metrics.compute_apnea_efficiency): Compute apnea efficiency. — kind: function — category: tasks
- [compute_apnea_hypopnea_index](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/apnea/metrics/#sleepkit.tasks.apnea.metrics.compute_apnea_hypopnea_index): Compute apnea hypopnea index (AHI). — kind: function — category: tasks
- [train](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/apnea/train/#sleepkit.tasks.apnea.train.train): Train sleep apnea model. — kind: function — category: tasks
- [subject_data_preprocessor](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/apnea/utils/#sleepkit.tasks.apnea.utils.subject_data_preprocessor): Preprocess entire subject data. — kind: function — category: tasks
- [create_data_pipeline](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/apnea/utils/#sleepkit.tasks.apnea.utils.create_data_pipeline): Create a data pipeline. — kind: function — category: tasks
- [StageTask](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/stage/#sleepkit.tasks.stage.StageTask): Sleep Stage Task — kind: class — category: tasks
- [get_stage_color_map](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/stage/demo/#sleepkit.tasks.stage.demo.get_stage_color_map): Get color map for sleep stages — kind: function — category: tasks
- [demo](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/stage/demo/#sleepkit.tasks.stage.demo.demo): Run sleep stage classification demo. — kind: function — category: tasks
- [evaluate](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/stage/evaluate/#sleepkit.tasks.stage.evaluate.evaluate): Evaluate sleep stage model. — kind: function — category: tasks
- [export](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/stage/export/#sleepkit.tasks.stage.export.export): Export sleep stage model. — kind: function — category: tasks
- [compute_sleep_stage_durations](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/stage/metrics/#sleepkit.tasks.stage.metrics.compute_sleep_stage_durations): Compute sleep stage durations — kind: function — category: tasks
- [compute_total_sleep_time](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/stage/metrics/#sleepkit.tasks.stage.metrics.compute_total_sleep_time): Compute total sleep time (# samples). — kind: function — category: tasks
- [compute_sleep_efficiency](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/stage/metrics/#sleepkit.tasks.stage.metrics.compute_sleep_efficiency): Compute sleep efficiency. — kind: function — category: tasks
- [train](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/stage/train/#sleepkit.tasks.stage.train.train): Train sleep stage model. — kind: function — category: tasks
- [subject_data_preprocessor](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/stage/utils/#sleepkit.tasks.stage.utils.subject_data_preprocessor): Preprocess entire subject data. — kind: function — category: tasks
- [create_data_pipeline](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/stage/utils/#sleepkit.tasks.stage.utils.create_data_pipeline): Create a data pipeline. — kind: function — category: tasks
- [Task](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/tasks/task/#sleepkit.tasks.task.Task): Task base class. All tasks should inherit from this class. — kind: class — category: tasks
- [PlotPallette](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/utils/plotting/#sleepkit.utils.plotting.PlotPallette): `dataclass` — kind: class — category: utils
- [setup_plotting](https://ambiqai.github.io/sleepkit/reference/api/sleepkit/utils/plotting/#sleepkit.utils.plotting.setup_plotting): Setup plotting environment for matplotlib and plotly — kind: function — category: utils