Skip to content

Commit

Permalink
remove the log_report_frequency from public access
Browse files Browse the repository at this point in the history
  • Loading branch information
Ubuntu committed Jan 11, 2024
1 parent 60b9a8d commit 1536c53
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 10 deletions.
7 changes: 1 addition & 6 deletions docs/source/configuration/configuration-run.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,11 +126,6 @@ GraphStorm provides a set of parameters to control how and where to save and res
- Yaml: ``task_tracker: sagemaker_task_tracker``
- Argument: ``--task_tracker sagemaker_task_tracker``
- Default value: ``sagemaker_task_tracker``
- **log_report_frequency**: The frequency of reporting model performance metrics through task_tracker. The frequency is defined by using number of iterations, i.e., every N iterations the evaluation metrics will be reported. (Please note the evaluation metrics should be generated at the reporting iteration. See "eval_frequency" for how evaluation frequency is controlled.)

- Yaml: ``log_report_frequency: 1000``
- Argument: ``--log-report-frequency 1000``
- Default value: ``1000``
- **restore_model_path**: A path where GraphStorm model parameters were saved. For training, if restore_model_path is set, GraphStom will retrieve the model parameters from restore_model_path instead of initializing the parameters. For inference, restore_model_path must be provided.

- Yaml: ``restore_model_path: /model/checkpoint/``
Expand Down Expand Up @@ -278,7 +273,7 @@ GraphStorm provides a set of parameters to control model evaluation.
- Yaml: ``use_mini_batch_infer: false``
- Argument: ``--use-mini-batch-infer false``
- Default value: ``true``
- **eval_frequency**: The frequency of doing evaluation. GraphStorm trainers do evaluation at the end of each epoch. However, for large-scale graphs, training one epoch may take hundreds of thousands of iterations. One may want to do evaluations in the middle of an epoch. When eval_frequency is set, every **eval_frequency** iterations, the trainer will do evaluation once. The evaluation results can be printed and reported. See **log_report_frequency** for more details.
- **eval_frequency**: The frequency of doing evaluation. GraphStorm trainers do evaluation at the end of each epoch. However, for large-scale graphs, training one epoch may take hundreds of thousands of iterations. One may want to do evaluations in the middle of an epoch. When eval_frequency is set, every **eval_frequency** iterations, the trainer will do evaluation once. The evaluation results can be printed and reported.

- Yaml: ``eval_frequency: 10000``
- Argument: ``--eval-frequency 10000``
Expand Down
3 changes: 0 additions & 3 deletions examples/peft_llm_gnn/nc_config_Video_Games.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,8 @@ gsf:
batch_size: 4
dropout: 0.1
eval_batch_size: 4
# eval_frequency: 100
#log_report_frequency: 50
lr: 0.0001
num_epochs: 10
# save_model_frequency: 300
wd_l2norm: 1.0e-06
input:
restore_model_path: null
Expand Down
2 changes: 1 addition & 1 deletion python/graphstorm/gsf.py
Original file line number Diff line number Diff line change
Expand Up @@ -656,4 +656,4 @@ def check_homo(g):

def create_builtin_task_tracker(config):
tracker_class = get_task_tracker_class(config.task_tracker)
return tracker_class(config.log_report_frequency)
return tracker_class(config.eval_frequency)

0 comments on commit 1536c53

Please sign in to comment.