Nudged Elastic Band

class mlipaudit.benchmarks.nudged_elastic_band.nudged_elastic_band.NudgedElasticBandBenchmark(force_field: ForceField | Calculator, data_input_dir: str | PathLike = './data', run_mode: RunMode | Literal['dev', 'fast', 'standard'] = RunMode.STANDARD)

Nudged Elastic Band benchmark.

name

The unique benchmark name that should be used to run the benchmark from the CLI and that will determine the output folder name for the result file. The name is nudged_elastic_band.

Type:

str

category

A string that describes the category of the benchmark, used for example, in the UI app for grouping. Default, if not overridden, is “General”. This benchmark’s category is “Small Molecules”.

Type:

str

result_class

A reference to the type of BenchmarkResult that will determine the return type of self.analyze(). The result class type is NEBResult.

Type:

type[mlipaudit.benchmark.BenchmarkResult] | None

model_output_class

A reference to the NEBModelOutput class.

Type:

type[mlipaudit.benchmark.ModelOutput] | None

required_elements

The set of element types that are present in the benchmark’s input files.

Type:

set[str] | None

skip_if_elements_missing

Whether the benchmark should be skipped entirely if there are some element types that the model cannot handle. If False, the benchmark must have its own custom logic to handle missing element types. For this benchmark, the attribute is set to True.

Type:

bool

__init__(force_field: ForceField | Calculator, data_input_dir: str | PathLike = './data', run_mode: RunMode | Literal['dev', 'fast', 'standard'] = RunMode.STANDARD) → None

Initializes the benchmark.

Parameters:

• force_field – The force field model to be benchmarked.

• data_input_dir – The local input data directory. Defaults to “./data”. If the subdirectory “{data_input_dir}/{benchmark_name}” exists, the benchmark expects the relevant data to be in there, otherwise it will download it from HuggingFace.

• run_mode – Whether to run the standard benchmark length, a faster version, or a very fast development version. Subclasses should ensure that when RunMode.DEV, their benchmark runs in a much shorter timeframe, by running on a reduced number of test cases, for instance. Implementing RunMode.FAST being different from RunMode.STANDARD is optional and only recommended for very long-running benchmarks. This argument can also be passed as a string “dev”, “fast”, or “standard”.

Raises:

• ChemicalElementsMissingError – If initialization is attempted with a force field that cannot perform inference on the required elements.

• ValueError – If force field type is not compatible.

run_model() → None

Run the NEB calculation.

analyze() → NEBResult

Analyze the NEB calculation.

Returns:

The result of the NEB calculation.

Return type:

NEBResult

Raises:

RuntimeError – If run_model() has not been called.

class mlipaudit.benchmarks.nudged_elastic_band.nudged_elastic_band.NEBResult(*, failed: bool = False, score: Annotated[float | None, Ge(ge=0), Le(le=1)] = None, reaction_results: list[NEBReactionResult], convergence_rate: float | None = None)

Result for a NEB calculation.

reaction_results

A dictionary of reaction results where the keys are the reaction identifiers. Inlcudes the failed reactions.

Type:

list[mlipaudit.benchmarks.nudged_elastic_band.nudged_elastic_band.NEBReactionResult]

convergence_rate

The fraction of converged reactions.

Type:

float | None

failed

Whether all the simulations or inferences failed and no analysis could be performed. Defaults to False.

Type:

bool

score

The final score for the benchmark between 0 and 1.

Type:

float | None

class mlipaudit.benchmarks.nudged_elastic_band.nudged_elastic_band.NEBModelOutput(*, simulation_states: list[SimulationState | None])

Model output for a NEB calculation.

simulation_states

A list of simulation states for every NEB reaction. None if the simulation failed.

Type:

list[mlip.simulation.state.SimulationState | None]