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.

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

ENH: Improve logging of runtime #1253

Merged
merged 1 commit into from
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 13 additions & 5 deletions mriqc/cli/run.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def main():

atexit.register(config.restore_env)

start_time = time.time()
config.settings.start_time = time.time()

# Run parser
parse_args()
Expand Down Expand Up @@ -176,8 +176,12 @@ def main():

generate_reports()

config.loggers.cli.log(26, messages.PARTICIPANT_FINISHED.format(
duration=time.strftime('%Hh %Mmin %Ss', time.gmtime(time.time() - start_time))
_subject_duration = time.gmtime(
(time.time() - config.settings.start_time)
/ sum(len(files) for files in config.workflow.inputs.values())
)
config.loggers.cli.log(25, messages.PARTICIPANT_FINISHED.format(
duration=time.strftime('%Hh %Mmin %Ss', _subject_duration)
))

if _resmon is not None:
Expand All @@ -200,7 +204,7 @@ def main():

from ..utils.misc import generate_tsv # , generate_pred

config.loggers.cli.info(messages.GROUP_START)
config.loggers.cli.log(26, messages.GROUP_START)

# Generate reports
mod_group_reports = []
Expand Down Expand Up @@ -242,7 +246,11 @@ def main():
config.loggers.cli.info(messages.BIDS_META)
write_derivative_description(config.execution.bids_dir, config.execution.output_dir)
write_bidsignore(config.execution.output_dir)
config.loggers.cli.info(messages.RUN_FINISHED)
config.loggers.cli.log(26, messages.RUN_FINISHED.format(
duration=time.strftime(
'%Hh %Mmin %Ss',
time.gmtime(time.time() - config.settings.start_time))
))
sys.exit(exitcode)


Expand Down
2 changes: 2 additions & 0 deletions mriqc/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,8 @@ class settings(_Config):

file_path: Path = None
"""Path to this configuration file."""
start_time: float = None
"""A :obj:`~time.time` timestamp at the time the workflow is started."""

_paths = ('file_path', )

Expand Down
17 changes: 11 additions & 6 deletions mriqc/messages.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@
DROPPING_NON_NUMERICAL = 'Dropping {n_labels} samples for having non-numerical labels'
GROUP_FINISHED = 'Group level finished successfully.'
GROUP_NO_DATA = 'No data found. No group level reports were generated.'
GROUP_START = 'Group level started...'
GROUP_START = """\
------------------------------------------------------------------
Generating group reports
------------------------------------------------------------------
"""
INDIVIDUAL_REPORT_GENERATED = 'Generated individual log: {out_file}'
PARTICIPANT_START = """\
------------------------------------------------------------------
Expand All @@ -42,15 +46,16 @@
{extra_messages}------------------------------------------------------------------
"""
PARTICIPANT_FINISHED = """\
----------------------------------------------------------------
Participant level finished successfully ({duration})
----------------------------------------------------------------
"""
Participant level finished successfully averaging {duration} per subject."""
POST_Z_NANS = 'Columns {nan_columns} contain NaNs after z-scoring.'
QC_UPLOAD_COMPLETE = 'QC metrics successfully uploaded.'
QC_UPLOAD_START = 'MRIQC Web API: submitting to <{url}>'
GROUP_REPORT_GENERATED = 'Group-{modality} report generated: {path}'
RUN_FINISHED = 'MRIQC completed.'
RUN_FINISHED = """\
----------------------------------------------------------------
MRIQC completed (elapsed time {duration}).
----------------------------------------------------------------
"""
SUSPICIOUS_DATA_TYPE = "Input image {in_file} has a suspicious data type: '{dtype}'"
TSV_GENERATED = 'Generated summary TSV table for {modality} data: {path}'
VOXEL_SIZE_OK = 'Voxel size is large enough.'
Expand Down
Loading