Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: fix docs for fp_task_min #1257

Merged
merged 2 commits into from
Jun 25, 2023
Merged

docs: fix docs for fp_task_min #1257

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79c280a
docs: fix docs for fp_task_min
njzjz Jun 23, 2023
07e7713
Update dpgen/generator/arginfo.py
njzjz Jun 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions dpgen/generator/arginfo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -848,13 +848,13 @@ def fp_style_variant_type_args() -> Variant:


def fp_args() -> List[Argument]:
doc_fp_task_max = "Maximum number of structures to be calculated in each system in 02.fp of each iteration."
doc_fp_task_min = "Minimum number of structures to be calculated in each system in 02.fp of each iteration."
doc_fp_task_max = "Maximum number of structures to be calculated in each system in 02.fp of each iteration. If the number of candidate structures exceeds `fp_task_max`, `fp_task_max` structures will be randomly picked from the candidates and labeled."
doc_fp_task_min = "Skip the training in the next iteration if the number of structures is no more than `fp_task_min`."
doc_fp_accurate_threshold = "If the accurate ratio is larger than this number, no fp calculation will be performed, i.e. fp_task_max = 0."
doc_fp_accurate_soft_threshold = "If the accurate ratio is between this number and fp_accurate_threshold, the fp_task_max linearly decays to zero."
doc_fp_cluster_vacuum = "If the vacuum size is smaller than this value, this cluster will not be choosen for labeling."
doc_fp_cluster_vacuum = "If the vacuum size is smaller than this value, this cluster will not be chosen for labeling."
doc_detailed_report_make_fp = (
"If set to true, detailed report will be generated for each iteration."
"If set to true, a detailed report will be generated for each iteration."
)
doc_ratio_failed = "Check the ratio of unsuccessfully terminated jobs. If too many FP tasks are not converged, RuntimeError will be raised."

Expand Down