Skip to content

Commit 4e9f061

Browse files
committed
add or ForceFieldMoleculeTaskDocument in the function descriptions
1 parent 524f037 commit 4e9f061

File tree

1 file changed

+34
-17
lines changed

1 file changed

+34
-17
lines changed

src/atomate2/forcefields/jobs.py

+34-17
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ def forcefield_job(method: Callable) -> job:
5353
settings for all forcefield jobs. For example, it ensures that large data objects
5454
(currently only trajectories) are all stored in the atomate2 data store.
5555
It also configures the output schema to be a
56-
ForceFieldStructureTaskDocument :obj:`.TaskDoc`.
56+
ForceFieldStructureTaskDocument :obj:`.TaskDoc`. or
57+
ForceFieldMoleculeTaskDocument :obj:`.TaskDoc`.
5758
5859
Any makers that return forcefield jobs (not flows) should decorate the
5960
``make`` method with @forcefield_job. For example:
@@ -121,7 +122,8 @@ class ForceFieldRelaxMaker(AseRelaxMaker):
121122
tags : list[str] or None
122123
A list of tags for the task.
123124
task_document_kwargs : dict (deprecated)
124-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
125+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
126+
:obj: `ForceFieldMoleculeTaskDocument`.
125127
"""
126128

127129
name: str = "Force field relax"
@@ -215,7 +217,8 @@ class ForceFieldStaticMaker(ForceFieldRelaxMaker):
215217
calculator_kwargs : dict
216218
Keyword arguments that will get passed to the ASE calculator.
217219
task_document_kwargs : dict (deprecated)
218-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
220+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
221+
:obj: `ForceFieldMoleculeTaskDocument`.
219222
"""
220223

221224
name: str = "Force field static"
@@ -258,7 +261,8 @@ class CHGNetRelaxMaker(ForceFieldRelaxMaker):
258261
calculator_kwargs : dict
259262
Keyword arguments that will get passed to the ASE calculator.
260263
task_document_kwargs : dict (deprecated)
261-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
264+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
265+
:obj: `ForceFieldMoleculeTaskDocument`.
262266
"""
263267

264268
name: str = f"{MLFF.CHGNet} relax"
@@ -294,7 +298,8 @@ class CHGNetStaticMaker(ForceFieldStaticMaker):
294298
calculator_kwargs : dict
295299
Keyword arguments that will get passed to the ASE calculator.
296300
task_document_kwargs : dict (deprecated)
297-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
301+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
302+
:obj: `ForceFieldMoleculeTaskDocument`.
298303
"""
299304

300305
name: str = f"{MLFF.CHGNet} static"
@@ -337,7 +342,8 @@ class M3GNetRelaxMaker(ForceFieldRelaxMaker):
337342
calculator_kwargs : dict
338343
Keyword arguments that will get passed to the ASE calculator.
339344
task_document_kwargs : dict (deprecated)
340-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
345+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
346+
:obj: `ForceFieldMoleculeTaskDocument`.
341347
"""
342348

343349
name: str = f"{MLFF.M3GNet} relax"
@@ -375,7 +381,8 @@ class M3GNetStaticMaker(ForceFieldStaticMaker):
375381
calculator_kwargs : dict
376382
Keyword arguments that will get passed to the ASE calculator.
377383
task_document_kwargs : dict (deprecated)
378-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
384+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
385+
:obj: `ForceFieldMoleculeTaskDocument`.
379386
"""
380387

381388
name: str = f"{MLFF.M3GNet} static"
@@ -418,7 +425,8 @@ class NEPRelaxMaker(ForceFieldRelaxMaker):
418425
calculator_kwargs : dict
419426
Keyword arguments that will get passed to the ASE calculator.
420427
task_document_kwargs : dict (deprecated)
421-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
428+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
429+
:obj: `ForceFieldMoleculeTaskDocument`.
422430
"""
423431

424432
name: str = f"{MLFF.NEP} relax"
@@ -454,7 +462,8 @@ class NEPStaticMaker(ForceFieldStaticMaker):
454462
calculator_kwargs : dict
455463
Keyword arguments that will get passed to the ASE calculator.
456464
task_document_kwargs : dict (deprecated)
457-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
465+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
466+
:obj: `ForceFieldMoleculeTaskDocument`.
458467
"""
459468

460469
name: str = f"{MLFF.NEP} static"
@@ -497,7 +506,8 @@ class NequipRelaxMaker(ForceFieldRelaxMaker):
497506
calculator_kwargs : dict
498507
Keyword arguments that will get passed to the ASE calculator.
499508
task_document_kwargs : dict (deprecated)
500-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
509+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
510+
:obj: `ForceFieldMoleculeTaskDocument`.
501511
"""
502512

503513
name: str = f"{MLFF.Nequip} relax"
@@ -532,7 +542,8 @@ class NequipStaticMaker(ForceFieldStaticMaker):
532542
calculator_kwargs : dict
533543
Keyword arguments that will get passed to the ASE calculator.
534544
task_document_kwargs : dict (deprecated)
535-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
545+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
546+
:obj: `ForceFieldMoleculeTaskDocument`.
536547
"""
537548

538549
name: str = f"{MLFF.Nequip} static"
@@ -579,7 +590,8 @@ class MACERelaxMaker(ForceFieldRelaxMaker):
579590
trained for Matbench Discovery on the MPtrj dataset available at
580591
https://figshare.com/articles/dataset/22715158.
581592
task_document_kwargs : dict (deprecated)
582-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
593+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
594+
:obj: `ForceFieldMoleculeTaskDocument`.
583595
"""
584596

585597
name: str = f"{MLFF.MACE_MP_0} relax"
@@ -619,7 +631,8 @@ class MACEStaticMaker(ForceFieldStaticMaker):
619631
trained for Matbench Discovery on the MPtrj dataset available at
620632
https://figshare.com/articles/dataset/22715158.
621633
task_document_kwargs : dict (deprecated)
622-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
634+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
635+
:obj: `ForceFieldMoleculeTaskDocument`.
623636
"""
624637

625638
name: str = f"{MLFF.MACE_MP_0} static"
@@ -668,7 +681,8 @@ class SevenNetRelaxMaker(ForceFieldRelaxMaker):
668681
trained for Matbench Discovery on the MPtrj dataset available at
669682
https://figshare.com/articles/dataset/22715158.
670683
task_document_kwargs : dict (deprecated)
671-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
684+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
685+
:obj: `ForceFieldMoleculeTaskDocument`.
672686
"""
673687

674688
name: str = f"{MLFF.SevenNet} relax"
@@ -710,7 +724,8 @@ class SevenNetStaticMaker(ForceFieldStaticMaker):
710724
trained for Matbench Discovery on the MPtrj dataset available at
711725
https://figshare.com/articles/dataset/22715158.
712726
task_document_kwargs : dict (deprecated)
713-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
727+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
728+
:obj: `ForceFieldMoleculeTaskDocument`.
714729
"""
715730

716731
name: str = f"{MLFF.SevenNet} static"
@@ -750,7 +765,8 @@ class GAPRelaxMaker(ForceFieldRelaxMaker):
750765
calculator_kwargs : dict
751766
Keyword arguments that will get passed to the ASE calculator.
752767
task_document_kwargs : dict (deprecated)
753-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
768+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
769+
:obj: `ForceFieldMoleculeTaskDocument`.
754770
"""
755771

756772
name: str = f"{MLFF.GAP} relax"
@@ -786,7 +802,8 @@ class GAPStaticMaker(ForceFieldStaticMaker):
786802
calculator_kwargs : dict
787803
Keyword arguments that will get passed to the ASE calculator.
788804
task_document_kwargs : dict (deprecated)
789-
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
805+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
806+
:obj: `ForceFieldMoleculeTaskDocument`.
790807
"""
791808

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

0 commit comments

Comments
 (0)