HeaderModel

class lsst.pipe.base.quantum_graph.HeaderModel(*, version: int = 1, graph_type: str = '', inputs: list[str] = <factory>, output: str | None = '', output_run: str = '', user: str = <factory>, timestamp: ~datetime.datetime = <factory>, command: str = <factory>, metadata: dict[str, ~typing.Any] = <factory>, int_size: int = 8, n_quanta: int = 0, n_datasets: int = 0, n_task_quanta: dict[str, int] = <factory>, provenance_dataset_id: ~uuid.UUID = <factory>)

Bases: BaseModel

Data model for the header of a quantum graph file.

Attributes Summary

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Methods Summary

copy(*args, **kwargs)	See pydantic.BaseModel.copy.
from_old_quantum_graph(old_quantum_graph)	Extract a header from an old QuantumGraph instance.
model_construct(*args, **kwargs)	See pydantic.BaseModel.model_construct.
model_copy(*args, **kwargs)	See pydantic.BaseModel.model_copy.
model_dump(*args, **kwargs)	See pydantic.BaseModel.model_dump.
model_dump_json(*args, **kwargs)	See pydantic.BaseModel.model_dump_json.
model_json_schema(*args, **kwargs)	See pydantic.BaseModel.model_json_schema.
model_validate(*args, **kwargs)	See pydantic.BaseModel.model_validate.
model_validate_json(*args, **kwargs)	See pydantic.BaseModel.model_validate_json.
model_validate_strings(*args, **kwargs)	See pydantic.BaseModel.model_validate_strings.
to_old_metadata()	Return a dictionary using the key conventions used in old quantum graph files.

Attributes Documentation

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Methods Documentation

copy(*args: Any, **kwargs: Any) → Any

See pydantic.BaseModel.copy.

classmethod from_old_quantum_graph(old_quantum_graph: QuantumGraph) → HeaderModel

Extract a header from an old QuantumGraph instance.

Parameters

old_quantum_graphQuantumGraph

Quantum graph to extract a header from.

Returns

headerPredictedHeaderModel

Header for a new predicted quantum graph.

classmethod model_construct(*args: Any, **kwargs: Any) → Any

See pydantic.BaseModel.model_construct.

model_copy(*args: Any, **kwargs: Any) → Any

See pydantic.BaseModel.model_copy.

model_dump(*args: Any, **kwargs: Any) → Any

See pydantic.BaseModel.model_dump.

model_dump_json(*args: Any, **kwargs: Any) → Any

See pydantic.BaseModel.model_dump_json.

classmethod model_json_schema(*args: Any, **kwargs: Any) → Any

See pydantic.BaseModel.model_json_schema.

classmethod model_validate(*args: Any, **kwargs: Any) → Any

See pydantic.BaseModel.model_validate.

classmethod model_validate_json(*args: Any, **kwargs: Any) → Any

See pydantic.BaseModel.model_validate_json.

classmethod model_validate_strings(*args: Any, **kwargs: Any) → Any

See pydantic.BaseModel.model_validate_strings.

to_old_metadata() → dict[str, Any]

Return a dictionary using the key conventions used in old quantum graph files.