salvus.opt.models.generic_model
salvus.opt.models.generic_model salvus opt models generic_model A generic model based on a numpy array.
Classes
GenericModel
GenericModelclass GenericModel(salvus.opt.models.base_model.BaseModel):
def __init__(self, name: str, data: str | pathlib.Path | npt.NDArray): ...Generic inversion model using a numpy array.
namestr — Name of the model.datastr | pathlib.Path | npt.NDArray — Model data.
data npt.NDArray
data npt.NDArrayThe model data as an arbitrary numpy array.
model npt.NDArray
model npt.NDArrayThe model as its actual representation.
name str
name strModel name.
status ModelStatus
status ModelStatusModel status to keep track of whether the model has been modified.
vector npt.NDArray
vector npt.NDArrayThe model data as a vector.
Returns: vector: The model data flattened to a 1D array.
from_disk()
from_disk()def from_disk(parent_folder: pathlib.Path, d: dict) -> GenericModel: ...Load a model from disk. This will use the dictionary and path provided.
parent_folderpathlib.Path — Path to store the model.ddict — Dictionary containing meta information of the model.
from_json()
from_json()def from_json(d: dict) -> Self: ...Create a model from a dictionary.
ddict — Dictionary containing meta information of the model.
copy()
copy()def copy(self, name: str) -> GenericModel: ...Copy the model.
namestr — Name of the new (copied) model.
dot()
dot()def dot(self, other: GenericModel) -> float: ...Dot product of the model with another model.
otherGenericModel — The other model.
get_metric()
get_metric()def get_metric(self) -> dict[str, npt.NDArray]: ...Get the metric for the model.
max()
max()def max(self, other: GenericModel) -> GenericModel: ...In-place point-wise maximum.
otherGenericModel — Model to compare with.
self.min()
min()def min(self, other: GenericModel) -> GenericModel: ...In-place point-wise minimum.
otherGenericModel — Model to compare with.
self.norm()
norm()def norm(self) -> float: ...Return the model norm.
norm_inf()
norm_inf()def norm_inf(self) -> float: ...Infinity norm of the model.
to_dict()
to_dict()def to_dict(self) -> dict[str, dict[str, npt.NDArray]]: ...Convert the model to a dictionary representation.
to_disk()
to_disk()def to_disk(self, parent_folder: pathlib.Path | str) -> dict: ...Serialize the model to JSON (and an associated npy file).
parent_folderpathlib.Path | str — Parent folder where the JSON + npy files should be stored.
to_json()
to_json()def to_json(
self,
external_file_hash: Optional[str] = None,
timer: Optional[salvus._core.timer.timer.Timer] = None,
log_to_logger: bool = False,
comm: Optional[int] = None,
) -> Dict: ...Serialize the object to a dictionary that can be written to JSON.
external_file_hashOptional[str] =None— Hash of any external files associated with this object. Can be passed here in which case it will be stored in a centralized location in the JSON file.timerOptional[salvus._core.timer.timer.Timer] =None— Execution timer.log_to_loggerbool =False— Log timings to the logger.commOptional[int] =None— MPI communicator, if any.
validate_consistency()
validate_consistency()def validate_consistency(
self, other: GenericModel, description: str = "other model"
) -> None: ...Check that another model has the same parameters and array shapes.
otherGenericModel — The model to compare to, e.g., a weight or a reference model.descriptionstr ='other model'— Name ofotherin error messages.