Skip to content

Commit cc61356

Browse files
committed
Updated Readme
1 parent 72c075c commit cc61356

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,26 @@ DFAnalyzer also provides a detailed breakdown of performance metrics for each la
111111
└─────────────────────────────┴──────────────────┴────────────────┴───────────┴────────────────────┴──────────────────┘
112112
```
113113

114+
## Report mode
115+
116+
You can now run all of the existing `dfreport.py` reports directly through the main `dfanalyzer` executable:
117+
118+
```bash
119+
# per-node summary:
120+
dfanalyzer --report --node /path/to/COMPACT/
121+
122+
# per-process, highlight the max across processes:
123+
dfanalyzer --report --process --aggregate /path/to/COMPACT/
124+
```
125+
#### How it works
126+
127+
- **`cli()`** inspects `sys.argv` before Hydra ever sees it.
128+
- If `--report` is present, we strip it out (so `argparse` in `dfreport.py` still works unchanged) and call `dfreport.main()`.
129+
- Otherwise we call the original `main()`, so nothing else in your toolchain is disturbed.
130+
- Finally, by repointing the `dfanalyzer` console script to `cli()`, any `dfanalyzer ...` invocation will first check for `--report`.
131+
132+
This gives you exactly what you asked for `dfanalyzer --report [dfreport options]` with minimal changes to the rest of the repo.
133+
114134
## Further Information
115135

116136
For more details, to report issues, or to contribute to DFAnalyzer, please refer to the following resources:

0 commit comments

Comments
 (0)