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

Fix missing parameter docstrings #609

Merged
merged 5 commits into from
Nov 26, 2024
Merged

Fix missing parameter docstrings #609

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
930c6e0
Included missing parameters' docstrings
Nov 18, 2024
6040f11
Fix mistake
Nov 18, 2024
cab6b12
Added documentation
Nov 19, 2024
ae2e0ed
Fixing minor issues
Nov 19, 2024
85146db
Fix typo and indentation
Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fixing minor issues
  • Loading branch information
nerkulec committed Nov 19, 2024
commit ae2e0edd3fbbd2f4ebdb4c420a77ebe465d1691d
2 changes: 1 addition & 1 deletion docs/source/advanced_usage/trainingmodel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ By default, the same number of snapshots as had been provided will be created
(if possible).

Logging metrics during training
******************
*******************************

Training progress in MALA can be visualized via tensorboard or wandb, as also shown
in the file ``advanced/ex03_tensor_board``. Simply select a logger prior to training as
Expand Down
6 changes: 3 additions & 3 deletions mala/common/parameters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -713,7 +713,7 @@ class ParametersRunning(ParametersBase):
validation_metrics : list
List of metrics to be used for validation. Default is ["ldos"].
Possible options are:
- "ldos": Loss on the LDOS.
- "ldos": MSE of the LDOS.
- "band_energy": Band energy.
- "band_energy_actual_fe": Band energy computed with ground truth Fermi energy.
- "total_energy": Total energy.
Expand Down Expand Up @@ -743,8 +743,8 @@ class ParametersRunning(ParametersBase):

profiler_range : list
List with two entries determining with which batch/iteration number
the CUDA profiler will start and stop profiling. Please note that
this option only holds significance if the nsys profiler is used.
the CUDA profiler will start and stop profiling. Please note that
this option only holds significance if the nsys profiler is used.
"""

def __init__(self):
Expand Down
Loading