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

[Enhancement] Support export logs of different ranks in debug mode #968

Merged
merged 19 commits into from
Mar 13, 2023

Conversation

HAOCHENYE
Copy link
Collaborator

@HAOCHENYE HAOCHENYE commented Feb 28, 2023

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

If the log_level is "DEBUG", logger will export logs of different ranks like this:

1 node 8 GPUs:

work_dir/20230228_141908
├── 20230306_183634_${hostname}_device0_rank0.log
├── 20230306_183634_${hostname}_device1_rank1.log
├── 20230306_183634_${hostname}_device2_rank2.log
├── 20230306_183634_${hostname}_device3_rank3.log
├── 20230306_183634_${hostname}_device4_rank4.log
├── 20230306_183634_${hostname}_device5_rank5.log
├── 20230306_183634_${hostname}_device6_rank6.log
├── 20230306_183634_${hostname}_device7_rank7.log
└── vis_data
    ├── 20230228_141908.json
    └── scalars.json

2 node 2 GPUs per node

work_dirs/mmlogger/20230228_153532
├── 20230228_153532_${hostname}_device0_rank0.log
├── 20230228_153532_${hostname}_device2_rank10.log
├── 20230228_153532_${hostname}_device3_rank11.log
├── 20230228_153532_${hostname}_device4_rank12.log
├── 20230228_153532_${hostname}_device5_rank13.log
├── 20230228_153532_${hostname}_device6_rank14.log
├── 20230228_153532_${hostname}_device7_rank15.log
├── 20230228_153532_${hostname}_device1_rank1.log
├── 20230228_153532_${hostname}_device2_rank2.log
├── 20230228_153532_${hostname}_device3_rank3.log
├── 20230228_153532_${hostname}_device4_rank4.log
├── 20230228_153532_${hostname}_device5_rank5.log
├── 20230228_153532_${hostname}_device6_rank6.log
├── 20230228_153532_${hostname}_device7_rank7.log
├── 20230228_153532_${hostname}_device0_rank8.log
├── 20230228_153532_${hostname}_device1_rank9.log
└── vis_data
    └── config.py

Modification

Please briefly describe what modification is made in this PR.

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repos?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

  1. Pre-commit or other linting tools are used to fix the potential lint issues.
  2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

@codecov
Copy link

codecov bot commented Feb 28, 2023

Codecov Report

❗ No coverage uploaded for pull request base (main@0d25625). Click here to learn what that means.
Patch has no changes to coverable lines.

❗ Current head 89b60fc differs from pull request most recent head fe4013c. Consider uploading reports for the commit fe4013c to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #968   +/-   ##
=======================================
  Coverage        ?   76.59%           
=======================================
  Files           ?      139           
  Lines           ?    11033           
  Branches        ?     2206           
=======================================
  Hits            ?     8451           
  Misses          ?     2216           
  Partials        ?      366           
Flag Coverage Δ
unittests 76.59% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Member

@RangiLyu RangiLyu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest adding hostname and local rank to the filename for multi-node debug.
For example:

import socket
        hostname = socket.gethostname()
        global_rank = get_rank()
        local_rank = int(os.environ['LOCAL_RANK'])

        self._log_dir = osp.join(
            self.work_dir, self.timestamp + '_rank' + str(global_rank) +
            '_localrank' + str(local_rank) + '_' + hostname)

@zhouzaida zhouzaida added this to the 0.7.0 milestone Mar 5, 2023
mmengine/logging/logger.py Outdated Show resolved Hide resolved
@zhouzaida zhouzaida linked an issue Mar 7, 2023 that may be closed by this pull request
@HAOCHENYE HAOCHENYE requested a review from C1rN09 as a code owner March 9, 2023 10:24
RangiLyu
RangiLyu previously approved these changes Mar 10, 2023
zhouzaida
zhouzaida previously approved these changes Mar 13, 2023
@zhouzaida zhouzaida merged commit 395ebf8 into open-mmlab:main Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] Logging muti-process running messages in DEBUG log level.
3 participants