-
Notifications
You must be signed in to change notification settings - Fork 497
Expand file tree
/
Copy pathtest_predict.py
More file actions
2112 lines (1740 loc) · 72.5 KB
/
Copy pathtest_predict.py
File metadata and controls
2112 lines (1740 loc) · 72.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Copyright (c) Meta Platforms, Inc. and affiliates.
This source code is licensed under the MIT license found in the
LICENSE file in the root directory of this source tree.
Tests: MLIPPredictUnit + ParallelMLIPPredictUnit — single-dataset
and multi-dataset prediction, internal graph-gen versions 2/3,
batching consistency, rotational invariance / out-of-plane
forces, Euler vs quaternion Wigner-D paths, merge-mole
consistency on supercells, single-atom lookup-patch path,
and the BatchServerPredictUnit deployment-end-to-end tests.
Models: uma-s-1p1 + uma-s-1p2 on most tests, uma-s-1p2 alone on a
few calibrated tests, uma-m-1p1 on the MOLE-merge tests
(per-test @pretrained locks). Some tests use the heavier
compile / merge-mole / quaternion-wigner inference settings.
CI: test_gpu_sweep (units shard) — all @pretrained-locked tests.
"""
from __future__ import annotations
import contextlib
import logging
import os
from copy import deepcopy
from types import SimpleNamespace
import numpy as np
import numpy.testing as npt
import pytest
import ray
import torch
from ase import Atoms
from ase.build import add_adsorbate, bulk, fcc100, make_supercell, molecule
from ase.data import chemical_symbols
from fairchem.core import FAIRChemCalculator
from fairchem.core.common import distutils
from fairchem.core.datasets.atomic_data import AtomicData, atomicdata_list_to_batch
from fairchem.core.datasets.common_structures import get_fcc_crystal_by_num_atoms
from fairchem.core.models.uma.compat import UMA_1P1_MODEL_ID
from fairchem.core.models.uma.nn.execution_backends import UMASFastGPUBackend
from fairchem.core.units.mlip_unit import InferenceSettings, MLIPPredictUnit
from fairchem.core.units.mlip_unit.mlip_unit import initialize_finetuning_model
from fairchem.core.units.mlip_unit.predict import (
ParallelMLIPPredictUnit,
_mark_dynamic_input_dimensions,
_prepare_inference_gradients,
)
from fairchem.core.units.mlip_unit.single_atom_patch import (
single_atom_prediction_from_lookup,
)
from tests.conftest import get_predict_unit_for_test, seed_everywhere
def _resolve_checkpoint_path(name_or_path: str) -> str:
"""
Resolve a model name or filesystem path to a checkpoint file path.
"""
if os.path.exists(name_or_path):
return name_or_path
from fairchem.core.calculate.pretrained_mlip import (
pretrained_checkpoint_path_from_name,
)
return pretrained_checkpoint_path_from_name(name_or_path)
FORCE_TOL = 1e-4
ATOL = 5e-4
@pytest.mark.parametrize(
("forces", "stress", "pos_grad", "cell_grad"),
[
(False, False, False, False),
(True, False, True, False),
(True, True, True, True),
],
)
def test_prepare_inference_gradients(forces, stress, pos_grad, cell_grad):
backbone = SimpleNamespace(
regress_config=SimpleNamespace(
direct_forces=False, forces=forces, stress=stress
)
)
data = {
"pos": torch.randn(4, 3),
"cell": torch.randn(1, 3, 3),
}
_prepare_inference_gradients(backbone, data)
assert data["pos"].requires_grad is pos_grad
assert data["cell"].requires_grad is cell_grad
_prepare_inference_gradients(SimpleNamespace(), data)
def test_mark_dynamic_input_dimensions_requires_fast_backend():
def make_data():
return {
"pos": torch.randn(4, 3),
"edge_index": torch.zeros(2, 8, dtype=torch.long),
}
data = make_data()
_mark_dynamic_input_dimensions(SimpleNamespace(), data)
assert not hasattr(data["pos"], "_dynamo_dynamic_indices")
assert not hasattr(data["edge_index"], "_dynamo_dynamic_indices")
backend = SimpleNamespace(supports_fused_edgewise=True)
data = make_data()
_mark_dynamic_input_dimensions(SimpleNamespace(backend=backend), data)
assert data["pos"]._dynamo_dynamic_indices == {0}
assert data["edge_index"]._dynamo_dynamic_indices == {1}
_REPRESENTATIVE_ELEMENTS = [
(1, 0, 2), # H: charge=0, spin=2
(6, 0, 3), # C: charge=0, spin=3
(8, 0, 3), # O: charge=0, spin=3
(11, 1, 1), # Na: charge=+1, spin=1
(79, 0, 2), # Au: charge=0, spin=2
]
SINGLE_ATOM_ENERGY_ATOL = 0.05 # eV, for model-predicted single atom energies
@pytest.mark.parametrize("tf32", [False, True])
def test_predict_uses_inference_tf32_and_restores_caller(tf32):
expected_precision = "high" if tf32 else "highest"
class PrecisionCheckingModel:
module = SimpleNamespace(
backbone=SimpleNamespace(
regress_config=SimpleNamespace(direct_forces=True),
)
)
def __call__(self, data):
assert torch.get_float32_matmul_precision() == expected_precision
assert torch.backends.cuda.matmul.allow_tf32 is tf32
assert torch.backends.cudnn.allow_tf32 is tf32
return {"configured_tf32": tf32}
predict_unit = MLIPPredictUnit.__new__(MLIPPredictUnit)
predict_unit.inference_settings = InferenceSettings(tf32=tf32)
predict_unit.model = PrecisionCheckingModel()
def passthrough_outputs(data, output, undo_refs):
return output
predict_unit._process_outputs = passthrough_outputs
original_precision = torch.get_float32_matmul_precision()
original_cudnn_tf32 = torch.backends.cudnn.allow_tf32
initial_precision = "high" if not tf32 else "highest"
try:
torch.set_float32_matmul_precision(initial_precision)
torch.backends.cudnn.allow_tf32 = not tf32
output = predict_unit._run_inference(data=None, undo_refs=False)
assert output == {"configured_tf32": tf32}
assert torch.get_float32_matmul_precision() == initial_precision
assert torch.backends.cuda.matmul.allow_tf32 is not tf32
assert torch.backends.cudnn.allow_tf32 is not tf32
finally:
torch.set_float32_matmul_precision(original_precision)
torch.backends.cudnn.allow_tf32 = original_cudnn_tf32
@pytest.fixture(scope="module")
def uma_predict_unit_cuda(pretrained_checkpoint):
"""Module-scoped predict unit using the UMA checkpoint under test, device=cuda."""
return get_predict_unit_for_test(pretrained_checkpoint, device="cuda")
@pytest.fixture(scope="module")
def uma_predict_unit(uma_predict_unit_cuda, pretrained_checkpoint):
"""Module-scoped predict unit - uses cuda version if available, otherwise cpu."""
if torch.cuda.is_available():
return uma_predict_unit_cuda
return get_predict_unit_for_test(pretrained_checkpoint)
@pytest.fixture(scope="module")
def uma_merge_mole_predict_unit(pretrained_checkpoint):
"""Module-scoped predict unit with merge_mole=True for MgO tests."""
settings = InferenceSettings(merge_mole=True, external_graph_gen=False)
return get_predict_unit_for_test(
pretrained_checkpoint, device="cuda", inference_settings=settings
)
@pytest.mark.gpu()
@pytest.mark.parametrize("internal_graph_gen_version", [2, 3])
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_single_dataset_predict(internal_graph_gen_version, pretrained_checkpoint):
inference_settings = InferenceSettings(
tf32=False,
activation_checkpointing=True,
merge_mole=False,
compile=False,
external_graph_gen=False,
internal_graph_gen_version=internal_graph_gen_version,
)
uma_predict_unit = get_predict_unit_for_test(
pretrained_checkpoint, inference_settings=inference_settings
)
n = 10
atoms = bulk("Pt")
atomic_data_list = [AtomicData.from_ase(atoms, task_name="omat") for _ in range(n)]
batch = atomicdata_list_to_batch(atomic_data_list)
preds = uma_predict_unit.predict(batch)
assert preds["energy"].shape == (n,)
assert preds["forces"].shape == (n, 3)
assert preds["stress"].shape == (n, 9)
# compare result with that from the calculator
calc = FAIRChemCalculator(uma_predict_unit, task_name="omat")
atoms.calc = calc
npt.assert_allclose(
preds["energy"].detach().cpu().numpy(), atoms.get_potential_energy()
)
npt.assert_allclose(preds["forces"].detach().cpu().numpy() - atoms.get_forces(), 0)
npt.assert_allclose(
preds["stress"].detach().cpu().numpy()
- atoms.get_stress(voigt=False).flatten(),
0,
atol=ATOL,
)
@pytest.mark.xfail(reason="Issue with UMA 1.2 release TODO fix")
@pytest.mark.gpu()
@pytest.mark.parametrize("internal_graph_gen_version", [2, 3])
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_multiple_dataset_predict(internal_graph_gen_version, pretrained_checkpoint):
inference_settings = InferenceSettings(
tf32=False,
activation_checkpointing=True,
merge_mole=False,
compile=False,
external_graph_gen=False,
internal_graph_gen_version=internal_graph_gen_version,
)
uma_predict_unit = get_predict_unit_for_test(
pretrained_checkpoint, inference_settings=inference_settings
)
h2o = molecule("H2O")
h2o.info.update({"charge": 0, "spin": 1})
h2o.pbc = True # all data points must be pbc if mixing.
slab = fcc100("Cu", (3, 3, 3), vacuum=8, periodic=True)
adsorbate = molecule("CO")
add_adsorbate(slab, adsorbate, 2.0, "bridge")
pt = bulk("Pt")
pt.repeat((2, 2, 2))
atomic_data_list = [
AtomicData.from_ase(
h2o,
task_name="omol",
r_data_keys=["spin", "charge"],
molecule_cell_size=120,
),
AtomicData.from_ase(slab, task_name="oc20"),
AtomicData.from_ase(pt, task_name="omat"),
]
batch = atomicdata_list_to_batch(atomic_data_list)
preds = uma_predict_unit.predict(batch)
n_systems = len(batch)
n_atoms = sum(batch.natoms).item()
assert preds["energy"].shape == (n_systems,)
assert preds["forces"].shape == (n_atoms, 3)
assert preds["stress"].shape == (n_systems, 9)
# compare to fairchem calcs
seed_everywhere(42)
omol_calc = FAIRChemCalculator(uma_predict_unit, task_name="omol")
oc20_calc = FAIRChemCalculator(uma_predict_unit, task_name="oc20")
omat_calc = FAIRChemCalculator(uma_predict_unit, task_name="omat")
pred_energy = preds["energy"].detach().cpu().numpy()
pred_forces = preds["forces"].detach().cpu().numpy()
h2o.calc = omol_calc
h2o.center(vacuum=120)
slab.calc = oc20_calc
pt.calc = omat_calc
npt.assert_allclose(pred_energy[0], h2o.get_potential_energy())
npt.assert_allclose(pred_energy[1], slab.get_potential_energy())
npt.assert_allclose(pred_energy[2], pt.get_potential_energy())
batch_batch = batch.batch.detach().cpu().numpy()
npt.assert_allclose(pred_forces[batch_batch == 0], h2o.get_forces(), atol=ATOL)
npt.assert_allclose(pred_forces[batch_batch == 1], slab.get_forces(), atol=ATOL)
npt.assert_allclose(pred_forces[batch_batch == 2], pt.get_forces(), atol=ATOL)
def _test_parallel_predict_unit_impl(
workers, device, checkpointing, graph_gen_version, pretrained_checkpoint
):
"""Implementation of parallel predict unit test."""
seed = 42
runs = 2
model_path = _resolve_checkpoint_path(pretrained_checkpoint)
num_atoms = 10
ifsets = InferenceSettings(
tf32=False,
merge_mole=True,
activation_checkpointing=checkpointing,
internal_graph_gen_version=graph_gen_version,
external_graph_gen=False,
)
atoms = get_fcc_crystal_by_num_atoms(num_atoms)
atomic_data = AtomicData.from_ase(atoms, task_name=["omat"])
seed_everywhere(seed)
ppunit = ParallelMLIPPredictUnit(
inference_model_path=model_path,
device=device,
inference_settings=ifsets,
num_workers=workers,
)
for _ in range(runs):
pp_results = ppunit.predict(atomic_data)
distutils.cleanup_gp_ray()
seed_everywhere(seed)
normal_predict_unit = get_predict_unit_for_test(
pretrained_checkpoint, device=device, inference_settings=ifsets
)
for _ in range(runs):
normal_results = normal_predict_unit.predict(atomic_data)
logging.info(f"normal_results: {normal_results}")
logging.info(f"pp_results: {pp_results}")
assert torch.allclose(
pp_results["energy"].detach().cpu(),
normal_results["energy"].detach().cpu(),
atol=ATOL,
)
assert torch.allclose(
pp_results["forces"].detach().cpu(),
normal_results["forces"].detach().cpu(),
atol=FORCE_TOL,
)
@pytest.mark.serial()
@pytest.mark.parametrize(
"workers, checkpointing, graph_gen_version",
[
(1, False, 2),
(2, False, 2),
(1, False, 3),
(1, True, 3),
(2, False, 3),
],
)
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_parallel_predict_unit_cpu(
workers, checkpointing, graph_gen_version, pretrained_checkpoint
):
_test_parallel_predict_unit_impl(
workers, "cpu", checkpointing, graph_gen_version, pretrained_checkpoint
)
@pytest.mark.gpu()
@pytest.mark.parametrize(
"workers, checkpointing, graph_gen_version",
[
(1, False, 2),
(1, True, 2),
(1, True, 3),
(1, False, 3),
# (2, False),
# (2, True),
],
)
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_parallel_predict_unit_gpu(
workers, checkpointing, graph_gen_version, pretrained_checkpoint
):
_test_parallel_predict_unit_impl(
workers, "cuda", checkpointing, graph_gen_version, pretrained_checkpoint
)
def _test_parallel_predict_unit_batch_impl(
workers, device, checkpointing, pretrained_checkpoint
):
"""Implementation of parallel predict unit batch test."""
seed = 42
runs = 1
model_path = _resolve_checkpoint_path(pretrained_checkpoint)
ifsets = InferenceSettings(
tf32=False,
merge_mole=False,
activation_checkpointing=checkpointing,
internal_graph_gen_version=2,
external_graph_gen=False,
)
# Create H2O and O molecules batch
h2o = molecule("H2O")
h2o.info.update({"charge": 0, "spin": 1})
h2o.pbc = True
o_atom = molecule("O")
o_atom.info.update({"charge": 0, "spin": 2}) # triplet oxygen
o_atom.pbc = True
h2o_data = AtomicData.from_ase(
h2o,
task_name="omol",
r_data_keys=["spin", "charge"],
molecule_cell_size=120,
)
o_data = AtomicData.from_ase(
o_atom,
task_name="omol",
r_data_keys=["spin", "charge"],
molecule_cell_size=120,
)
atomic_data = atomicdata_list_to_batch([h2o_data, o_data])
seed_everywhere(seed)
ppunit = ParallelMLIPPredictUnit(
inference_model_path=model_path,
device=device,
inference_settings=ifsets,
num_workers=workers,
)
for _ in range(runs):
pp_results = ppunit.predict(atomic_data)
distutils.cleanup_gp_ray()
seed_everywhere(seed)
normal_predict_unit = get_predict_unit_for_test(
pretrained_checkpoint, device=device, inference_settings=ifsets
)
for _ in range(runs):
normal_results = normal_predict_unit.predict(atomic_data)
assert torch.allclose(
pp_results["energy"].detach().cpu(),
normal_results["energy"].detach().cpu(),
atol=ATOL,
)
assert torch.allclose(
pp_results["forces"].detach().cpu(),
normal_results["forces"].detach().cpu(),
atol=FORCE_TOL,
)
@pytest.mark.serial()
@pytest.mark.parametrize(
"workers, checkpointing",
[
(1, False),
(2, True),
],
)
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_parallel_predict_unit_batch(workers, checkpointing, pretrained_checkpoint):
_test_parallel_predict_unit_batch_impl(
workers, "cpu", checkpointing, pretrained_checkpoint
)
@pytest.mark.gpu()
@pytest.mark.parametrize(
"workers, checkpointing",
[
(1, True),
(1, False),
# (2, True),
# (2, False),
],
)
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_parallel_predict_unit_batch_gpu(workers, checkpointing, pretrained_checkpoint):
_test_parallel_predict_unit_batch_impl(
workers, "cuda", checkpointing, pretrained_checkpoint
)
@pytest.mark.gpu()
@pytest.mark.parametrize(
"padding",
[
(0),
(1),
(32),
],
)
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_batching_consistency(padding, pretrained_checkpoint):
"""Test that batched and unbatched predictions are consistent."""
# Get the appropriate predict unit
ifsets = InferenceSettings(
tf32=False,
merge_mole=False,
activation_checkpointing=True,
internal_graph_gen_version=2,
external_graph_gen=False,
edge_chunk_size=padding,
)
predict_unit = get_predict_unit_for_test(
pretrained_checkpoint, device="cuda", inference_settings=ifsets
)
# Create H2O molecule
h2o = molecule("H2O")
h2o.info.update({"charge": 0, "spin": 1})
h2o.pbc = True
# Create system of two oxygen atoms 100 A apart
from ase import Atoms
o_atom = Atoms("O2", positions=[[0.0, 0.0, 0.0], [100.0, 0.0, 0.0]])
o_atom.info.update({"charge": 0, "spin": 4}) # two triplet oxygens -> quintet
o_atom.pbc = True
# Convert to AtomicData
h2o_data = AtomicData.from_ase(
h2o,
task_name="omol",
r_data_keys=["spin", "charge"],
molecule_cell_size=120,
)
o_data = AtomicData.from_ase(
o_atom,
task_name="omol",
r_data_keys=["spin", "charge"],
molecule_cell_size=120,
)
# Batch 1: [H2O, O]
batch1 = atomicdata_list_to_batch([h2o_data, o_data])
seed_everywhere(42)
preds1 = predict_unit.predict(batch1)
# Batch 2: [H2O]
batch2 = atomicdata_list_to_batch([h2o_data])
seed_everywhere(42)
preds2 = predict_unit.predict(batch2)
# Batch 3: [O]
batch3 = atomicdata_list_to_batch([o_data])
seed_everywhere(42)
preds3 = predict_unit.predict(batch3)
# Assert energies match
assert torch.allclose(preds1["energy"][0], preds2["energy"][0], atol=ATOL)
assert torch.allclose(preds1["energy"][1], preds3["energy"][0], atol=ATOL)
# Assert forces match
batch1_batch = batch1.batch
h2o_forces_batch1 = preds1["forces"][batch1_batch == 0]
o_forces_batch1 = preds1["forces"][batch1_batch == 1]
h2o_forces_batch2 = preds2["forces"]
o_forces_batch3 = preds3["forces"]
assert torch.allclose(h2o_forces_batch1, h2o_forces_batch2, atol=ATOL)
assert torch.allclose(o_forces_batch1, o_forces_batch3, atol=ATOL)
# Assert stress matches
assert torch.allclose(preds1["stress"][0], preds2["stress"][0], atol=ATOL)
assert torch.allclose(preds1["stress"][1], preds3["stress"][0], atol=ATOL)
# ---------------------------------------------------------------------------
# Rotation / out-of-plane force invariance tests (planar molecules)
# For H2O and NH2 in ASE default coordinates, all atoms lie in the yz plane (x=0).
# Thus out-of-plane component is simply the x-component of the forces.
# ---------------------------------------------------------------------------
def _random_rotation_matrix(rng: np.random.Generator) -> np.ndarray:
"""Generate a 3D rotation matrix from two angles in [0, 2π).
We sample two independent angles:
phi ~ U(0, 2π) (rotation about z)
theta ~ U(0, 2π) (rotation about y)
The resulting rotation: R = Rz(phi) * Ry(theta)
Note: This is NOT a uniform (Haar) distribution over SO(3), but
satisfies the requested two-angle construction.
"""
phi = rng.uniform(0.0, 2.0 * np.pi)
theta = rng.uniform(0.0, 2.0 * np.pi)
cphi, sphi = np.cos(phi), np.sin(phi)
cth, sth = np.cos(theta), np.sin(theta)
Rz = np.array([[cphi, -sphi, 0.0], [sphi, cphi, 0.0], [0.0, 0.0, 1.0]])
Ry = np.array([[cth, 0.0, sth], [0.0, 1.0, 0.0], [-sth, 0.0, cth]])
return Rz @ Ry
@pytest.mark.gpu()
@pytest.mark.parametrize("mol_name", ["H2O", "NH2"])
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_rotational_invariance_out_of_plane(mol_name, uma_predict_unit_cuda):
rng = np.random.default_rng(seed=123)
calc = FAIRChemCalculator(uma_predict_unit_cuda, task_name="omol")
atoms = molecule(mol_name)
atoms.info.update({"charge": 0, "spin": 1})
atoms.calc = calc
orig_positions = atoms.get_positions().copy()
n_rot = 50 # fewer rotations for speed
for _ in range(n_rot):
R = _random_rotation_matrix(rng)
rotated_pos = orig_positions @ R.T
atoms.set_positions(rotated_pos)
rot_forces = atoms.get_forces()
# Unrotate forces back to original frame (covariant transformation)
unrot_forces = rot_forces @ R
assert (np.abs(unrot_forces[:, 0]) < FORCE_TOL).all()
@pytest.mark.gpu()
@pytest.mark.parametrize("mol_name", ["H2O", "NH2"])
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_original_out_of_plane_forces(mol_name, uma_predict_unit_cuda):
calc = FAIRChemCalculator(uma_predict_unit_cuda, task_name="omol")
atoms = molecule(mol_name)
atoms.info.update({"charge": 0, "spin": 1})
atoms.calc = calc
forces = atoms.get_forces()
print(f"Max out-of-plane forces for {mol_name}: {np.abs(forces[:, 0]).max()}")
assert np.abs(forces[:, 0]).max() < FORCE_TOL
# ---------------------------------------------------------------------------
# Euler vs Quaternion Wigner D agreement tests
# ---------------------------------------------------------------------------
def _get_predict_unit_with_wigner_mode(
use_quaternion: bool, pretrained_checkpoint: str
):
"""
Create a predict unit with the specified Wigner D computation mode.
"""
settings = InferenceSettings(
tf32=False,
activation_checkpointing=True,
merge_mole=False,
compile=False,
external_graph_gen=False,
use_quaternion_wigner=use_quaternion,
)
return get_predict_unit_for_test(
pretrained_checkpoint, device="cuda", inference_settings=settings
)
@pytest.mark.gpu()
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_euler_vs_quaternion_random_molecule(pretrained_checkpoint):
"""
Euler and quaternion Wigner D paths produce identical energy and forces
for a random molecule with no Y-aligned edges.
"""
# Methanol (CH3OH) - 6 atoms, no edges along Y axis
atoms = molecule("CH3OH")
# Apply a rotation to ensure no edges are Y-aligned
rng = np.random.default_rng(seed=42)
R = _random_rotation_matrix(rng)
atoms.set_positions(atoms.get_positions() @ R.T)
atoms.info.update({"charge": 0, "spin": 1})
atoms.pbc = True
predict_euler = _get_predict_unit_with_wigner_mode(False, pretrained_checkpoint)
predict_quat = _get_predict_unit_with_wigner_mode(True, pretrained_checkpoint)
data = AtomicData.from_ase(
atoms,
task_name="omol",
r_data_keys=["spin", "charge"],
molecule_cell_size=120,
)
batch = atomicdata_list_to_batch([data])
seed_everywhere(42)
preds_euler = predict_euler.predict(batch)
seed_everywhere(42)
preds_quat = predict_quat.predict(batch)
npt.assert_allclose(
preds_euler["energy"].detach().cpu().numpy(),
preds_quat["energy"].detach().cpu().numpy(),
atol=ATOL,
err_msg="Energy differs between Euler and quaternion paths",
)
npt.assert_allclose(
preds_euler["forces"].detach().cpu().numpy(),
preds_quat["forces"].detach().cpu().numpy(),
atol=ATOL,
err_msg="Forces differ between Euler and quaternion paths",
)
@pytest.mark.gpu()
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_euler_vs_quaternion_bulk(pretrained_checkpoint):
"""
Euler and quaternion Wigner D paths produce identical energy, forces,
and stress for a bulk crystal with no Y-aligned edges.
"""
# FCC Cu 2x2x2 supercell with a random perturbation to avoid symmetry
atoms = bulk("Cu")
atoms = atoms.repeat((2, 2, 2))
rng = np.random.default_rng(seed=99)
atoms.set_positions(
atoms.get_positions() + rng.normal(0, 0.05, atoms.positions.shape)
)
predict_euler = _get_predict_unit_with_wigner_mode(False, pretrained_checkpoint)
predict_quat = _get_predict_unit_with_wigner_mode(True, pretrained_checkpoint)
data = AtomicData.from_ase(atoms, task_name="omat")
batch = atomicdata_list_to_batch([data])
seed_everywhere(42)
preds_euler = predict_euler.predict(batch)
seed_everywhere(42)
preds_quat = predict_quat.predict(batch)
npt.assert_allclose(
preds_euler["energy"].detach().cpu().numpy(),
preds_quat["energy"].detach().cpu().numpy(),
atol=ATOL,
err_msg="Energy differs between Euler and quaternion paths (bulk)",
)
npt.assert_allclose(
preds_euler["forces"].detach().cpu().numpy(),
preds_quat["forces"].detach().cpu().numpy(),
atol=ATOL,
err_msg="Forces differ between Euler and quaternion paths (bulk)",
)
npt.assert_allclose(
preds_euler["stress"].detach().cpu().numpy(),
preds_quat["stress"].detach().cpu().numpy(),
atol=ATOL,
err_msg="Stress differs between Euler and quaternion paths (bulk)",
)
@pytest.mark.gpu()
@pytest.mark.parametrize(
"supercell_matrix",
[
2 * np.eye(3), # 2x2x2 supercell (8 atoms)
3 * np.eye(3), # 3x3x3 supercell (27 atoms)
np.array([[2, 0, 0], [0, 3, 0], [0, 0, 1]]), # 2x3x1 supercell (6 atoms)
],
)
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_merge_mole_with_supercell(supercell_matrix, uma_merge_mole_predict_unit):
atoms_orig = bulk("MgO", "rocksalt", a=4.213)
calc = FAIRChemCalculator(uma_merge_mole_predict_unit, task_name="omat")
atoms_orig.calc = calc
energy_orig = atoms_orig.get_potential_energy()
forces_orig = atoms_orig.get_forces()
atoms_super = make_supercell(atoms_orig, supercell_matrix)
num_atoms_ratio = len(atoms_super) / len(atoms_orig)
atoms_super.calc = calc
energy_super = atoms_super.get_potential_energy()
forces_super = atoms_super.get_forces()
energy_ratio = energy_super / energy_orig
npt.assert_allclose(
energy_ratio,
num_atoms_ratio,
rtol=0.01, # 1% tolerance
err_msg=f"Energy scaling is incorrect for supercell. "
f"Expected ratio: {num_atoms_ratio}, got: {energy_ratio}",
)
mean_force_mag_orig = np.linalg.norm(forces_orig, axis=1).mean()
mean_force_mag_super = np.linalg.norm(forces_super, axis=1).mean()
npt.assert_allclose(
mean_force_mag_orig,
mean_force_mag_super,
rtol=0.1, # 10% tolerance (forces can vary slightly due to numerical precision)
atol=1e-5,
err_msg=f"Mean force magnitude differs significantly between original and supercell. "
f"Original: {mean_force_mag_orig}, Supercell: {mean_force_mag_super}",
)
@pytest.mark.gpu()
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_merge_mole_composition_check(pretrained_checkpoint):
atoms_cu = bulk("Cu", "fcc", a=3.6)
settings = InferenceSettings(merge_mole=True, external_graph_gen=False)
predict_unit = get_predict_unit_for_test(
pretrained_checkpoint, device="cuda", inference_settings=settings
)
calc = FAIRChemCalculator(predict_unit, task_name="omat")
atoms_cu.calc = calc
_ = atoms_cu.get_potential_energy()
atoms_al = bulk("Al", "fcc", a=4.05)
atoms_al.calc = calc
with pytest.raises(
AssertionError,
match="Compositions differ from merged model",
):
_ = atoms_al.get_potential_energy()
@pytest.mark.gpu()
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_merge_mole_vs_non_merged_consistency(pretrained_model_name):
"""Test that merged and non-merged versions produce identical results."""
atoms = bulk("MgO", "rocksalt", a=4.213)
# Test with merge_mole=True
settings_merged = InferenceSettings(merge_mole=True, external_graph_gen=False)
predict_unit_merged = get_predict_unit_for_test(
pretrained_model_name, device="cuda", inference_settings=settings_merged
)
calc_merged = FAIRChemCalculator(predict_unit_merged, task_name="omat")
atoms_merged = atoms.copy()
atoms_non_merged = atoms.copy()
atoms_merged.calc = calc_merged
energy_merged = atoms_merged.get_potential_energy()
forces_merged = atoms_merged.get_forces()
stress_merged = atoms_merged.get_stress(voigt=False)
distutils.cleanup_gp_ray() # Ensure clean state before next test
# Test with merge_mole=False
settings_non_merged = InferenceSettings(merge_mole=False, external_graph_gen=False)
predict_unit_non_merged = get_predict_unit_for_test(
pretrained_model_name, device="cuda", inference_settings=settings_non_merged
)
calc_non_merged = FAIRChemCalculator(predict_unit_non_merged, task_name="omat")
atoms_non_merged.calc = calc_non_merged
energy_non_merged = atoms_non_merged.get_potential_energy()
forces_non_merged = atoms_non_merged.get_forces()
stress_non_merged = atoms_non_merged.get_stress(voigt=False)
# Assert that results are identical
npt.assert_allclose(
energy_merged,
energy_non_merged,
rtol=1e-6,
atol=1e-6,
err_msg=f"Energies differ: merged={energy_merged}, non-merged={energy_non_merged}",
)
npt.assert_allclose(
forces_merged,
forces_non_merged,
rtol=1e-6,
atol=1e-6,
err_msg="Forces differ between merged and non-merged versions",
)
npt.assert_allclose(
stress_merged,
stress_non_merged,
rtol=1e-6,
atol=1e-6,
err_msg="Stress differs between merged and non-merged versions",
)
@pytest.mark.gpu()
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_merge_mole_supercell_energy_forces_consistency(uma_merge_mole_predict_unit):
atoms_orig = bulk("MgO", "rocksalt", a=4.213)
calc = FAIRChemCalculator(uma_merge_mole_predict_unit, task_name="omat")
atoms_orig.calc = calc
energy1 = atoms_orig.get_potential_energy()
atoms_2x = make_supercell(atoms_orig, 2 * np.eye(3))
atoms_2x.calc = calc
energy_2x = atoms_2x.get_potential_energy()
atoms_3x = make_supercell(atoms_orig, 3 * np.eye(3))
atoms_3x.calc = calc
energy_3x = atoms_3x.get_potential_energy()
energy1_again = atoms_orig.get_potential_energy()
npt.assert_allclose(energy1, energy1_again, rtol=1e-6)
npt.assert_allclose(energy_2x / energy1, 8.0, rtol=0.01)
npt.assert_allclose(energy_3x / energy1, 27.0, rtol=0.01)
@pytest.mark.gpu()
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_merge_mole_consistent_batch(pretrained_checkpoint):
"""Test that merge_mole works for batch_size > 1 when all systems have identical composition."""
atoms = bulk("MgO", "rocksalt", a=4.213)
n_systems = 3
settings = InferenceSettings(merge_mole=True, external_graph_gen=False)
predict_unit = get_predict_unit_for_test(
pretrained_checkpoint, device="cuda", inference_settings=settings
)
atomic_data_list = [
AtomicData.from_ase(atoms, task_name="omat") for _ in range(n_systems)
]
batch = atomicdata_list_to_batch(atomic_data_list)
preds = predict_unit.predict(batch)
assert preds["energy"].shape == (n_systems,)
assert preds["forces"].shape == (n_systems * len(atoms), 3)
assert torch.isfinite(preds["energy"]).all()
assert torch.isfinite(preds["forces"]).all()
@pytest.mark.gpu()
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_merge_mole_inconsistent_batch(pretrained_checkpoint):
"""Test that merge_mole raises AssertionError when batch contains systems with different compositions."""
settings = InferenceSettings(merge_mole=True, external_graph_gen=False)
predict_unit = get_predict_unit_for_test(
pretrained_checkpoint, device="cuda", inference_settings=settings
)
atomic_data_list = [
AtomicData.from_ase(bulk("MgO", "rocksalt", a=4.213), task_name="omat"),
AtomicData.from_ase(bulk("Cu", "fcc", a=3.6), task_name="omat"),
]
batch = atomicdata_list_to_batch(atomic_data_list)
with pytest.raises(AssertionError, match="same reduced composition"):
predict_unit.predict(batch)
@pytest.mark.gpu()
@pytest.mark.pretrained("uma-s-1p1", "uma-s-1p2")
def test_merge_mole_batch_predict_matches_single(pretrained_checkpoint):
"""Test that merging on a multi-system batch gives consistent single-system predictions.
Merging MOLE on a batch of N identical systems should yield the same inference
results as merging on a single system when predicting on that same single system.
"""
atoms = bulk("MgO", "rocksalt", a=4.213)
atoms_supercell = make_supercell(atoms, 2 * np.eye(3))
settings = InferenceSettings(merge_mole=True, external_graph_gen=False)
predict_unit = get_predict_unit_for_test(
pretrained_checkpoint, device="cuda", inference_settings=settings
)
batch_of_two = atomicdata_list_to_batch(
[AtomicData.from_ase(a, task_name="omat") for a in (atoms, atoms_supercell)]
)
preds_batch = predict_unit.predict(batch_of_two)
batch_single = atomicdata_list_to_batch(
[AtomicData.from_ase(atoms, task_name="omat")]
)
preds_single = predict_unit.predict(batch_single)
n_atoms = len(atoms)
npt.assert_allclose(
preds_batch["energy"][0].item(),
preds_single["energy"][0].item(),
atol=ATOL,
err_msg="Energy for first batch system differs from single system prediction",
)
npt.assert_allclose(
preds_batch["forces"][:n_atoms].cpu().numpy(),
preds_single["forces"].cpu().numpy(),
atol=ATOL,
err_msg="Forces for first batch system differ from single system prediction",