From 0e666986aacfb724791db4b22fb294410428df39 Mon Sep 17 00:00:00 2001 From: Maksymilian Wojnar Date: Sun, 25 Feb 2024 21:58:43 +0100 Subject: [PATCH] Rename logging module to loggers module in docs --- README.md | 2 +- docs/source/getting_started.rst | 8 ++++---- docs/source/index.rst | 6 +++--- docs/source/{logging.rst => loggers.rst} | 4 ++-- reinforced_lib/rlib.py | 8 ++++---- 5 files changed, 14 insertions(+), 14 deletions(-) rename docs/source/{logging.rst => loggers.rst} (97%) diff --git a/README.md b/README.md index d82fcaa..7f5fa87 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ within of the library, represented in the API as different modules. - **Extensions** - Enhance agent observations with domain-specific knowledge by adding a suitable extension from the *Extensions* module. This module enables seamless agent switching and parameter tuning without extensive reconfiguration. -- **Logging** - This module allows you to monitor agent-environment interactions. Customize and adapt logging to your +- **Loggers** - This module allows you to monitor agent-environment interactions. Customize and adapt logging to your specific needs, capturing training metrics, internal agent state, or environment observations. The library includes various loggers for creating plots and output files, simplifying visualization and data processing. diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index f715b94..46ec54c 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -118,12 +118,12 @@ flag to ``False`` in the ``sample`` method: action = rl.sample(*env_state, is_training=False) -Logging +Loggers ------- -The logging module provides a simple yet powerful API for visualizing and analyzing the running algorithm or watching +The loggers module provides a simple yet powerful API for visualizing and analyzing the running algorithm or watching the training process. You can monitor any observations passed to the agent, the agent's state, and the basic metrics in -real time. If you want to learn more about the logging module, check out the :ref:`Custom loggers ` +real time. If you want to learn more about the loggers module, check out the :ref:`Custom loggers ` section. Basic logging @@ -144,7 +144,7 @@ parameter specifies the predefined source of the logger. The source is a name of or the metric. `TensorBoard `_ is a powerful visualization toolkit that allows you to monitor the training process in real time, create interactive visualizations, and save the logs for later analysis. You can use the ``TensorboardLogger`` along with other loggers built into Reinforced-lib. To learn more about -available loggers, check out the :ref:`Logging module ` section. +available loggers, check out the :ref:`Loggers module ` section. .. warning:: diff --git a/docs/source/index.rst b/docs/source/index.rst index 5f77cde..8c472c3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -28,7 +28,7 @@ Reinforced-lib facilitates seamless interaction between RL agents and the enviro * **Extensions** -- Enhance agent observations with domain-specific knowledge by adding a suitable extension from the *Extensions* module. This module enables seamless agent switching and parameter tuning without extensive reconfiguration. -* **Logging** -- This module allows you to monitor agent-environment interactions. Customize and adapt logging to your specific needs, capturing training metrics, internal agent state, or environment observations. The library includes various loggers for creating plots and output files, simplifying visualization and data processing. +* **Loggers** -- This module allows you to monitor agent-environment interactions. Customize and adapt logging to your specific needs, capturing training metrics, internal agent state, or environment observations. The library includes various loggers for creating plots and output files, simplifying visualization and data processing. The figure below provides a visual representation of Reinforced-lib and the data-flow between its modules. @@ -67,7 +67,7 @@ API Documentation * :ref:`API ` * :ref:`Agents ` * :ref:`Extensions ` -* :ref:`Logging ` +* :ref:`Loggers ` * :ref:`Utils ` * :ref:`Exceptions ` @@ -91,7 +91,7 @@ API Documentation API Agents Extensions - Logging + Loggers Utils Exceptions diff --git a/docs/source/logging.rst b/docs/source/loggers.rst similarity index 97% rename from docs/source/logging.rst rename to docs/source/loggers.rst index 6a8f674..e44c1a1 100644 --- a/docs/source/logging.rst +++ b/docs/source/loggers.rst @@ -1,6 +1,6 @@ -.. _logging_page: +.. _loggers_page: -Logging module +Loggers module ============== This module is a set of loggers. You can either choose one of our built-in loggers or implement diff --git a/reinforced_lib/rlib.py b/reinforced_lib/rlib.py index 387f2be..ba2e52e 100644 --- a/reinforced_lib/rlib.py +++ b/reinforced_lib/rlib.py @@ -56,7 +56,7 @@ class RLib: ext_params : dict, optional Parameters of the selected extension. logger_types : type or list[type], optional - Types of the selected logging modules. Must inherit from the ``BaseLogger`` class. + Types of the selected loggers. Must inherit from the ``BaseLogger`` class. logger_sources : Source or list[Source], optional Sources to log. logger_params : dict, optional @@ -214,11 +214,11 @@ def set_loggers( Parameters ---------- logger_types : type or list[type] - Types of the selected logging modules. + Types of the selected loggers. logger_sources : Source or list[Source], optional Sources to log. logger_params : dict, optional - Parameters of the selected logging modules. + Parameters of the selected loggers. """ if not self._init_loggers: @@ -502,7 +502,7 @@ def load( ext_params : dict[str, any], optional Dictionary of altered extension parameters with their new values, by default None. logger_types : type or list[type], optional - Types of the selected logging modules. Must inherit from the ``BaseLogger`` class. + Types of the selected loggers. Must inherit from the ``BaseLogger`` class. logger_sources : Source or list[Source], optional Sources to log. logger_params : dict, optional