[Logger] - introduce a uniform system for logging information, warnings and errors across Supervision

[SkalskiP]

Description

This system will empower users to selectively filter messages based on their importance or pause logging as needed.

Essential features of this upgraded system include:

• Enable users to specify the severity level for each logged message, categorizing them as informational, warnings, or errors.
• Ensure each log entry denotes its originating file, enhancing traceability and issue resolution.
• Each entry in the log should carry a timestamp, marking the exact moment of occurrence.
• Introduce a mechanism to regulate the frequency of log entries, preventing user inundation and enhancing readability.

Additional

• Note: Please share a Google Colab with minimal code to test the new feature. We know it's additional work, but it will speed up the review process. The reviewer must test each change. Setting up a local environment to do this is time-consuming. Please ensure that Google Colab can be accessed without any issues (make it public). Thank you! 🙏🏻

[iamhatesz]

Hey @SkalskiP

I'd like to work on this issue, however I don't see there's a need for development work here.

Enable users to specify the severity level for each logged message, categorizing them as informational, warnings, or errors.
Ensure each log entry denotes its originating file, enhancing traceability and issue resolution.
Each entry in the log should carry a timestamp, marking the exact moment of occurrence.

This could be easily solved with the built-in logging:

LOG = logging.getLogger(__name__)

# ...

LOG.info("Doing something very important")

This captures the level of the message, location, and timestamp. Usually, it's up to the user to configure the logger to his preferences (formatting, handlers, etc.). If you think this might be useful, we can provide a helper setup_logger function that configures defaults for the supervision package. Even if users won't be interested in this feature, it still might be useful for developers.

Introduce a mechanism to regulate the frequency of log entries, preventing user inundation and enhancing readability.

Could you elaborate more on this requirement? So far, I've seen this useful for warnings (e.g. DeprecationWarning or UserWarning), but this is also available in the standard library (warnings). If you find this useful also for logging messages, I might introduce a filter for that.

[SkalskiP]

Hi @iamhatesz 👋🏻

• The logger would primarily be useful for individuals contributing to Supervision rather than for users.
• I would like a setup_logger to ensure a consistent logging format throughout the library.
• Truthfully, using the logging would be convenient for me. I'd prefer not to add new dependencies to supervision.
• Do you have any idea how to solve log suppression? Suppose you are processing a video, and the log would show for each frame, and we would like it not to happen more than once a minute.

[Bhavay-2001]

Hi @SkalskiP, is this issue for beginners? Can I give it a try?

[iamhatesz]

Hey @SkalskiP! I've just submitted a PR for this: #925 Would be great if you can take a look