danieldeutsch / sacrerouge

SacreROUGE is a library dedicated to the use and development of text generation evaluation metrics with an emphasis on summarization.
Apache License 2.0
134 stars 11 forks source link

Setup logging #4

Closed danieldeutsch closed 4 years ago

danieldeutsch commented 4 years ago

There are some warning messages that are printed to stdout. Example:

https://github.com/danieldeutsch/sacrerouge/blob/fcf06afae22efbc508cdd316173612adb2f81efd/sacrerouge/commands/correlate.py#L42

There are also some instances where it would be nice to have some more information logged. For example, when we create a new process and run a command, it would be nice for the command which is being run to be logged:

https://github.com/danieldeutsch/sacrerouge/blob/fcf06afae22efbc508cdd316173612adb2f81efd/sacrerouge/metrics/rouge.py#L188-L189

The task here would be to implement real logging (like using the logging library) so that (1) by default, log messages are printed to stdout, (2) the logging can also be written to a file using a new --log-file argument to commands like sacrerouge evaluate and sacrerouge score, and (3) the stdout log could be suppressed with a --silent flag to those commands.

For now, it would be good first step to get the above 3 items done, and then later we can add more useful logging messages (like for the second example above).