Skip to content

Commit

Permalink
More comprehensive documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
LysandreJik committed Oct 11, 2023
1 parent e479035 commit 6a60643
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/source/en/main_classes/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ that has already been deprecated and `DeprecationWarning` to indicate an upcomin
We use both in the `transformers` library. We leverage and adapt `logging`'s `captureWarning` method to allow
management of these warning messages by the verbosity setters above.

What does that mean for developers of the library? We should respect the following heuristic:
- `warnings` should be favored for developers of the library and libraries dependent on `transformers`
- `logging` should be used for end-users of the library using it in every-day projects

See reference of the `captureWarnings` method below.

[[autodoc]] logging.captureWarnings
Expand Down

0 comments on commit 6a60643

Please sign in to comment.