Logging fix for hf_api, logging documentation
#748
Conversation
| ``` | ||
|
|
||
| ## Controlling the logging of `huggingface_hub` |
There was a problem hiding this comment.
Should this information be in README? How are we going to create the documentation for this library? We probably need quite a few user guides and I think this should go in one of those, which probably should be located in the /doc folder.
There was a problem hiding this comment.
I'm putting this here for now, but this should definitely be in a separate guide as outlined in https://github.com/huggingface/huggingface_hub/issues/754
src/huggingface_hub/hf_api.py
Outdated
| logging.error( | ||
| "HfApi.login: This method is deprecated in favor of `set_access_token`." | ||
| warnings.warn( | ||
| "HfApi.login: This method is deprecated in favor of `set_access_token`.", |
There was a problem hiding this comment.
should we mention when it will be removed? Do we have a deprecation cycle policy?
There was a problem hiding this comment.
I'm adding a mention to v0.7: we should remove this as soon as possible, but there are downstream libraries using it still, so it's important to give them time to switch.
There's no written deprecation cycle policy, but I agree it would be welcome.
| match=r"HfApi.login: This method is deprecated in favor of " | ||
| r"`set_access_token` and will be removed in v0.7.", |
There was a problem hiding this comment.
I think this is not black formatted.
There was a problem hiding this comment.
Actually, it is! I've split it in two to respect the 88 line char limit, black seems okay with it
There was a problem hiding this comment.
Black unindented it, the second line was previously indented at the same level as the | in match=|
This fixes an issue with the logging of
hf_api, replaceslogger.errorfor deprecation warnings by aFutureWarning, and adds a small document regarding how to use logging withhuggingface_hub.cc @FrancescoSaverioZuppichini as you have raised the issue with
hf_apithis morning.