PineForge HPO 1.11.0
Native hyperparameter optimization for PineForge strategies
Loading...
Searching...
No Matches
pineforge_hpo.continuation Namespace Reference

Classes

class  ContinuationDataContext
 
class  SpaceExhaustedError
 
class  WarmHistory
 
class  WarmStartError
 

Functions

dict[str, Any] recorded_space (StudySpec study)
 
str canonical_space (dict[str, Any] space)
 
str space_hash (StudySpec study)
 
int|None cardinality (StudySpec study)
 
WarmHistory load_warm_start (StudySpec study, str|Path path, *ContinuationDataContext|None data_context=None)
 
bool is_binary_warm (str|Path path)
 
dict[str, Any] warm_start_metadata (StudySpec study, str|Path path, *str|Path|None native=None, bool defer_symbol_feeds=False)
 
dict[str, Any] space_info (StudySpec study, str|Path|None warm_start=None, *str|Path|None native=None)
 

Variables

int SPACE_HASH_VERSION = 1
 
int WARM_START_EXIT = 4
 
int SPACE_EXHAUSTED_EXIT = 5
 

Detailed Description

Portable search-space identity and read-only continuation preflight.

Function Documentation

◆ canonical_space()

str pineforge_hpo.continuation.canonical_space ( dict[str, Any]  space)
Return canonical v1 JSON; numeric identities are independent of formatting.

Definition at line 143 of file continuation.py.

◆ cardinality()

int | None pineforge_hpo.continuation.cardinality ( StudySpec  study)
Exact uint64 cardinality, or None for continuous/overflowing spaces.

Definition at line 189 of file continuation.py.

Referenced by pineforge_hpo.continuation.space_info(), and pineforge_hpo.continuation.warm_start_metadata().

◆ is_binary_warm()

bool pineforge_hpo.continuation.is_binary_warm ( str | Path  path)
Detect binary input without reading its payload or interpreting JSON.

Definition at line 537 of file continuation.py.

Referenced by pineforge_hpo.continuation.warm_start_metadata().

◆ load_warm_start()

WarmHistory pineforge_hpo.continuation.load_warm_start ( StudySpec  study,
str | Path  path,
*ContinuationDataContext | None   data_context = None 
)
Auto-detect fd-3 JSONL, a complete result object, or its trials array.

Definition at line 386 of file continuation.py.

Referenced by pineforge_hpo.continuation.warm_start_metadata().

◆ recorded_space()

dict[str, Any] pineforge_hpo.continuation.recorded_space ( StudySpec  study)
Return the version-independent declarative space recorded in results.

Definition at line 85 of file continuation.py.

◆ space_hash()

str pineforge_hpo.continuation.space_hash ( StudySpec  study)
SHA-256 of canonical v1 JSON, independent of package versions and pins.

Definition at line 184 of file continuation.py.

◆ space_info()

dict[str, Any] pineforge_hpo.continuation.space_info ( StudySpec  study,
str | Path | None   warm_start = None,
*str | Path | None   native = None 
)
Inspect coverage without compiling a strategy, loading data, or drawing candidates.

Definition at line 591 of file continuation.py.

References pineforge_hpo.continuation.cardinality(), and pineforge_hpo.continuation.warm_start_metadata().

◆ warm_start_metadata()

dict[str, Any] pineforge_hpo.continuation.warm_start_metadata ( StudySpec  study,
str | Path  path,
*str | Path | None   native = None,
bool   defer_symbol_feeds = False 
)
Inspect sampler history; binary validation stays in the native mmap loader.

Definition at line 543 of file continuation.py.

References pineforge_hpo.continuation.cardinality(), pineforge_hpo.continuation.is_binary_warm(), and pineforge_hpo.continuation.load_warm_start().

Referenced by pineforge_hpo.continuation.space_info().

Variable Documentation

◆ SPACE_EXHAUSTED_EXIT

int pineforge_hpo.continuation.SPACE_EXHAUSTED_EXIT = 5

Definition at line 30 of file continuation.py.

◆ SPACE_HASH_VERSION

int pineforge_hpo.continuation.SPACE_HASH_VERSION = 1

Definition at line 28 of file continuation.py.

◆ WARM_START_EXIT

int pineforge_hpo.continuation.WARM_START_EXIT = 4

Definition at line 29 of file continuation.py.