compute_predictions

Command-line usage

usage: cell compute_predictions [-h] [-plf None] [-sep False] [-srf None]
                                target_filepath property_name model_filepath

positional arguments:
  target_filepath       Path to a serialized StructuresSet (.db, .json, .xyz)
                        or DerivativeStructures (.pickle, .pkl) object.
  property_name         Name of the property where predictions are stored.
  model_filepath        Path to a serialized CE model.

options:
  -h, --help            show this help message and exit
  -plf, --plat-filepath None
                        Optional path to a serialized ParentLattice object
                        used for validation.
  -sep, --store-ensemble-predictions False
                        Whether to store ensemble predictions. Only applicable
                        if the model is an ensemble. Default: False.
  -srf, --source-filepath None
                        Optional source file (.db, .json, .xyz, .pickle, or
                        .pkl). Defaults to target_filepath.

Arguments and behavior

clusterx.cli.compute_predictions.compute_predictions(target_filepath, property_name, model_filepath, plat_filepath=None, store_ensemble_predictions=False, source_filepath=None)

Compute CE-model predictions and store them in the serialized target.

Structure sets can be read from and written to ASE databases (.db, .json) and CELL extended XYZ files (.xyz). If source_filepath is provided, predictions are computed for its structures and saved to target_filepath. A structure-set source is converted to DerivativeStructures when the target has a .pickle or .pkl extension, using the same conversion as convert_sset_to_dss and preserving its properties and masks.