pineforge_hpo.study_spec.StudySpec Class Reference

Public Member Functions
Mapping[str, ParameterSpec]	search_space (self)
Mapping[str, JsonScalar]	fixed_inputs (self)
Mapping[str, JsonScalar]	overrides (self)
"StudySpec"	from_json (cls, str|Path path, *bool require_files=False)

Static Public Attributes
int	schema_version
str	mode
StrategySpec	strategy
tuple	datasets [DatasetSpec, ...]
ObjectiveSpec	objective
SamplerSpec	sampler
ExecutionSpec	execution
Path	spec_path

Detailed Description

Fully validated and path-resolved executable StudySpec v1.

Definition at line 119 of file study_spec.py.

Member Function Documentation

fixed_inputs()

Mapping[str, JsonScalar] pineforge_hpo.study_spec.StudySpec.fixed_inputs

(

self

)

Return Pine inputs applied unchanged to every trial.

Definition at line 138 of file study_spec.py.

References pineforge_hpo.study_spec.StudySpec.strategy.

from_json()

"StudySpec" pineforge_hpo.study_spec.StudySpec.from_json	(		cls,
		str | Path	path,
		*bool	require_files = False
	)

Load a StudySpec with the same validation as :func:`load_study_spec`.

Definition at line 150 of file study_spec.py.

overrides()

Mapping[str, JsonScalar] pineforge_hpo.study_spec.StudySpec.overrides

(

self

)

Return runtime ``strategy(...)`` overrides applied to every trial.

Definition at line 144 of file study_spec.py.

References pineforge_hpo.study_spec.StudySpec.strategy.

search_space()

Mapping[str, ParameterSpec] pineforge_hpo.study_spec.StudySpec.search_space

(

self

)

Return the selected strategy's tunable input dimensions.

Definition at line 132 of file study_spec.py.

References pineforge_hpo.study_spec.StudySpec.strategy.

Member Data Documentation

datasets

tuple pineforge_hpo.study_spec.StudySpec.datasets [DatasetSpec, ...]

static

Definition at line 125 of file study_spec.py.

execution

ExecutionSpec pineforge_hpo.study_spec.StudySpec.execution

static

Definition at line 128 of file study_spec.py.

mode

str pineforge_hpo.study_spec.StudySpec.mode

static

Definition at line 123 of file study_spec.py.

objective

ObjectiveSpec pineforge_hpo.study_spec.StudySpec.objective

static

Definition at line 126 of file study_spec.py.

sampler

SamplerSpec pineforge_hpo.study_spec.StudySpec.sampler

static

Definition at line 127 of file study_spec.py.

schema_version

int pineforge_hpo.study_spec.StudySpec.schema_version

static

Definition at line 122 of file study_spec.py.

spec_path

Path pineforge_hpo.study_spec.StudySpec.spec_path

static

Definition at line 129 of file study_spec.py.

strategy

StrategySpec pineforge_hpo.study_spec.StudySpec.strategy

static

Definition at line 124 of file study_spec.py.

Referenced by pineforge_hpo.study_spec.StudySpec.fixed_inputs(), pineforge_hpo.study_spec.StudySpec.overrides(), and pineforge_hpo.study_spec.StudySpec.search_space().

---

The documentation for this class was generated from the following file:

• study_spec.py