Skip to content

Commit d8592fd

Browse files
committed
add or ForceFieldMoleculeTaskDocument in the function descriptions
1 parent 03761de commit d8592fd

File tree

1 file changed

+34
-17
lines changed

1 file changed

+34
-17
lines changed

src/atomate2/forcefields/jobs.py

Lines changed: 34 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ def forcefield_job(method: Callable) -> job:
5555
settings for all forcefield jobs. For example, it ensures that large data objects
5656
(currently only trajectories) are all stored in the atomate2 data store.
5757
It also configures the output schema to be a
58-
ForceFieldStructureTaskDocument :obj:`.TaskDoc`.
58+
ForceFieldStructureTaskDocument :obj:`.TaskDoc`. or
59+
ForceFieldMoleculeTaskDocument :obj:`.TaskDoc`.
5960
6061
Any makers that return forcefield jobs (not flows) should decorate the
6162
``make`` method with @forcefield_job. For example:
@@ -123,7 +124,8 @@ class ForceFieldRelaxMaker(AseRelaxMaker):
123124
tags : list[str] or None
124125
A list of tags for the task.
125126
task_document_kwargs : dict (deprecated)
126-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
127+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
128+
:obj: `ForceFieldMoleculeTaskDocument`.
127129
"""
128130

129131
name: str = "Force field relax"
@@ -217,7 +219,8 @@ class ForceFieldStaticMaker(ForceFieldRelaxMaker):
217219
calculator_kwargs : dict
218220
Keyword arguments that will get passed to the ASE calculator.
219221
task_document_kwargs : dict (deprecated)
220-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
222+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
223+
:obj: `ForceFieldMoleculeTaskDocument`.
221224
"""
222225

223226
name: str = "Force field static"
@@ -260,7 +263,8 @@ class CHGNetRelaxMaker(ForceFieldRelaxMaker):
260263
calculator_kwargs : dict
261264
Keyword arguments that will get passed to the ASE calculator.
262265
task_document_kwargs : dict (deprecated)
263-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
266+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
267+
:obj: `ForceFieldMoleculeTaskDocument`.
264268
"""
265269

266270
name: str = f"{MLFF.CHGNet} relax"
@@ -296,7 +300,8 @@ class CHGNetStaticMaker(ForceFieldStaticMaker):
296300
calculator_kwargs : dict
297301
Keyword arguments that will get passed to the ASE calculator.
298302
task_document_kwargs : dict (deprecated)
299-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
303+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
304+
:obj: `ForceFieldMoleculeTaskDocument`.
300305
"""
301306

302307
name: str = f"{MLFF.CHGNet} static"
@@ -339,7 +344,8 @@ class M3GNetRelaxMaker(ForceFieldRelaxMaker):
339344
calculator_kwargs : dict
340345
Keyword arguments that will get passed to the ASE calculator.
341346
task_document_kwargs : dict (deprecated)
342-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
347+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
348+
:obj: `ForceFieldMoleculeTaskDocument`.
343349
"""
344350

345351
name: str = f"{MLFF.M3GNet} relax"
@@ -377,7 +383,8 @@ class M3GNetStaticMaker(ForceFieldStaticMaker):
377383
calculator_kwargs : dict
378384
Keyword arguments that will get passed to the ASE calculator.
379385
task_document_kwargs : dict (deprecated)
380-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
386+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
387+
:obj: `ForceFieldMoleculeTaskDocument`.
381388
"""
382389

383390
name: str = f"{MLFF.M3GNet} static"
@@ -420,7 +427,8 @@ class NEPRelaxMaker(ForceFieldRelaxMaker):
420427
calculator_kwargs : dict
421428
Keyword arguments that will get passed to the ASE calculator.
422429
task_document_kwargs : dict (deprecated)
423-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
430+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
431+
:obj: `ForceFieldMoleculeTaskDocument`.
424432
"""
425433

426434
name: str = f"{MLFF.NEP} relax"
@@ -456,7 +464,8 @@ class NEPStaticMaker(ForceFieldStaticMaker):
456464
calculator_kwargs : dict
457465
Keyword arguments that will get passed to the ASE calculator.
458466
task_document_kwargs : dict (deprecated)
459-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
467+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
468+
:obj: `ForceFieldMoleculeTaskDocument`.
460469
"""
461470

462471
name: str = f"{MLFF.NEP} static"
@@ -499,7 +508,8 @@ class NequipRelaxMaker(ForceFieldRelaxMaker):
499508
calculator_kwargs : dict
500509
Keyword arguments that will get passed to the ASE calculator.
501510
task_document_kwargs : dict (deprecated)
502-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
511+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
512+
:obj: `ForceFieldMoleculeTaskDocument`.
503513
"""
504514

505515
name: str = f"{MLFF.Nequip} relax"
@@ -534,7 +544,8 @@ class NequipStaticMaker(ForceFieldStaticMaker):
534544
calculator_kwargs : dict
535545
Keyword arguments that will get passed to the ASE calculator.
536546
task_document_kwargs : dict (deprecated)
537-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
547+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
548+
:obj: `ForceFieldMoleculeTaskDocument`.
538549
"""
539550

540551
name: str = f"{MLFF.Nequip} static"
@@ -581,7 +592,8 @@ class MACERelaxMaker(ForceFieldRelaxMaker):
581592
trained for Matbench Discovery on the MPtrj dataset available at
582593
https://figshare.com/articles/dataset/22715158.
583594
task_document_kwargs : dict (deprecated)
584-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
595+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
596+
:obj: `ForceFieldMoleculeTaskDocument`.
585597
"""
586598

587599
name: str = f"{MLFF.MACE_MP_0} relax"
@@ -621,7 +633,8 @@ class MACEStaticMaker(ForceFieldStaticMaker):
621633
trained for Matbench Discovery on the MPtrj dataset available at
622634
https://figshare.com/articles/dataset/22715158.
623635
task_document_kwargs : dict (deprecated)
624-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
636+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
637+
:obj: `ForceFieldMoleculeTaskDocument`.
625638
"""
626639

627640
name: str = f"{MLFF.MACE_MP_0} static"
@@ -670,7 +683,8 @@ class SevenNetRelaxMaker(ForceFieldRelaxMaker):
670683
trained for Matbench Discovery on the MPtrj dataset available at
671684
https://figshare.com/articles/dataset/22715158.
672685
task_document_kwargs : dict (deprecated)
673-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
686+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
687+
:obj: `ForceFieldMoleculeTaskDocument`.
674688
"""
675689

676690
name: str = f"{MLFF.SevenNet} relax"
@@ -712,7 +726,8 @@ class SevenNetStaticMaker(ForceFieldStaticMaker):
712726
trained for Matbench Discovery on the MPtrj dataset available at
713727
https://figshare.com/articles/dataset/22715158.
714728
task_document_kwargs : dict (deprecated)
715-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
729+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
730+
:obj: `ForceFieldMoleculeTaskDocument`.
716731
"""
717732

718733
name: str = f"{MLFF.SevenNet} static"
@@ -752,7 +767,8 @@ class GAPRelaxMaker(ForceFieldRelaxMaker):
752767
calculator_kwargs : dict
753768
Keyword arguments that will get passed to the ASE calculator.
754769
task_document_kwargs : dict (deprecated)
755-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
770+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
771+
:obj: `ForceFieldMoleculeTaskDocument`.
756772
"""
757773

758774
name: str = f"{MLFF.GAP} relax"
@@ -788,7 +804,8 @@ class GAPStaticMaker(ForceFieldStaticMaker):
788804
calculator_kwargs : dict
789805
Keyword arguments that will get passed to the ASE calculator.
790806
task_document_kwargs : dict (deprecated)
791-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
807+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
808+
:obj: `ForceFieldMoleculeTaskDocument`.
792809
"""
793810

794811
name: str = f"{MLFF.GAP} static"

0 commit comments

Comments
 (0)