-
Notifications
You must be signed in to change notification settings - Fork 429
Include run_name in training logs for better run traceability #101
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.
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
base: main
Are you sure you want to change the base?
Conversation
|
What do you think @Mayankm96 ? |
|
@ClemensSchwarke we need a Logger class asap 🔥 |
|
|
||
| str = f" \033[1m Learning iteration {locs['it']}/{locs['tot_iter']} \033[0m " | ||
|
|
||
| run_name = self.cfg.get("run_name") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about using --task for the run name instead of an additional --run_name parameter? Also i think we need to update the config example with the additional name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
run_name actually already exists. It is just the time stamp by default but can be passed as a CLI argument.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it make sense to use run_name and not task still?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think so because task would usually be the same for all your trainings. If you want to differentiate them you would need run_name.
Description
Previously, during training, the
on_policy_runnerlogging output did not display the current run name, making it harder to distinguish logs between different training sessions when multiple runs were launched in succession or in parallel.To improve the training log clarity and traceability, I added support to display the configured
run_namein the logging output ofrsl_rl/runners/on_policy_runner.py.If the
run_namefield is specified in the configuration—such as in the Isaac Lab training example:./isaaclab.sh -p scripts/reinforcement_learning/rsl_rl/train.py \ --task Isaac-Cartpole-v0 --run_name cartpole_rsl_rl—the run name will now appear in each log update under the label "Run name:":
This enhancement helps users quickly identify the corresponding training session, which is especially useful when monitoring multiple or long-running experiments.
This addition is optional and non-intrusive: if
run_nameis not set, the log display remains unchanged.What’s Changed
run_nameadded to training logs inon_policy_runner.py.run_nameis conditionally fetched fromself.cfgand formatted neatly using the same padded alignment style as other log fields.run_nameis not defined.Type of Change
Checklist
pre-commit run --all-filesand all pre-commit checks passrun_namewhen providedrun_nameis not set)