add logging in the doc

Author: thomwolf

docs/source/index.rst

@@ -73,3 +73,4 @@ The documentation is organized in five parts:
     package_reference/loading_methods
     package_reference/main_classes
     package_reference/builder_classes
+    package_reference/logging_methods

docs/source/package_reference/logging_methods.rst

@@ -0,0 +1,50 @@
+Logging methods
+----------------------------------------------------
+
+`nlp` tries to be very transparent and explicit about it's inner working bt this can be quite verbose at some time.
+A series of logging methods let you easily adjust the level of logging of the whole library.
+
+Functions
+~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: nlp.logging.get_verbosity
+
+.. autofunction:: nlp.logging.set_verbosity
+
+.. autofunction:: nlp.logging.set_verbosity_info
+
+.. autofunction:: nlp.logging.set_verbosity_warning
+
+.. autofunction:: nlp.logging.set_verbosity_debug
+
+.. autofunction:: nlp.logging.set_verbosity_error
+
+.. autofunction:: nlp.logging.disable_default_handler
+
+.. autofunction:: nlp.logging.enable_default_handler
+
+.. autofunction:: nlp.logging.disable_propagation
+
+.. autofunction:: nlp.logging.enable_propagation
+
+.. autofunction:: nlp.logging.get_logger
+
+Levels
+~~~~~~~~~~~~~~~~~~~~~
+
+.. autodata:: nlp.logging.CRITICAL
+
+.. autodata:: nlp.logging.DEBUG
+
+.. autodata:: nlp.logging.ERROR
+
+.. autodata:: nlp.logging.FATAL
+
+.. autodata:: nlp.logging.INFO
+
+.. autodata:: nlp.logging.NOTSET
+
+.. autodata:: nlp.logging.WARN
+
+.. autodata:: nlp.logging.WARNING
+

src/nlp/utils/logging.py

@@ -76,7 +76,7 @@ def _reset_library_root_logger() -> None:
 
 def get_logger(name: Optional[str] = None) -> logging.Logger:
     """Return a logger with the specified name.
-    This function is not supposed to be directly accessed by library users.
+    This function can be used in dataset and metrics scripts.
     """
 
     if name is None:
@@ -115,18 +115,42 @@ def set_verbosity(verbosity: int) -> None:
 
 
 def set_verbosity_info():
+    """Set the level for the HuggingFace Transformers's root logger to INFO.
+
+    This will display most of the logging information and tqdm bars.
+
+    Shortcut to ``nlp.logging.set_verbosity(nlp.logging.INFO)``
+    """
     return set_verbosity(INFO)
 
 
 def set_verbosity_warning():
+    """Set the level for the HuggingFace Transformers's root logger to WARNING.
+
+    This will display only the warning and errors logging information (no tqdm bars).
+
+    Shortcut to ``nlp.logging.set_verbosity(nlp.logging.WARNING)``
+    """
     return set_verbosity(WARNING)
 
 
 def set_verbosity_debug():
+    """Set the level for the HuggingFace Transformers's root logger to DEBUG.
+
+    This will display all the logging information and tqdm bars.
+
+    Shortcut to ``nlp.logging.set_verbosity(nlp.logging.DEBUG)``
+    """
     return set_verbosity(DEBUG)
 
 
 def set_verbosity_error():
+    """Set the level for the HuggingFace Transformers's root logger to ERROR.
+
+    This will display only the errors logging information (no tqdm bars).
+
+    Shortcut to ``nlp.logging.set_verbosity(nlp.logging.ERROR)``
+    """
     return set_verbosity(ERROR)