Skip to content

Commit

Permalink
Rename logging module to loggers module in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
m-wojnar committed Feb 25, 2024
1 parent 2b5bd5d commit 0e66698
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <custom_loggers>`
real time. If you want to learn more about the loggers module, check out the :ref:`Custom loggers <custom_loggers>`
section.

Basic logging
Expand All @@ -144,7 +144,7 @@ parameter specifies the predefined source of the logger. The source is a name of
or the metric. `TensorBoard <https://www.tensorflow.org/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 <logging_page>` section.
available loggers, check out the :ref:`Loggers module <loggers_page>` section.

.. warning::

Expand Down
6 changes: 3 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -67,7 +67,7 @@ API Documentation
* :ref:`API <api_page>`
* :ref:`Agents <agents_page>`
* :ref:`Extensions <extensions_page>`
* :ref:`Logging <logging_page>`
* :ref:`Loggers <loggers_page>`
* :ref:`Utils <utils_page>`
* :ref:`Exceptions <exceptions_page>`

Expand All @@ -91,7 +91,7 @@ API Documentation
API <api>
Agents <agents>
Extensions <extensions>
Logging <logging>
Loggers <loggers>
Utils <utils>
Exceptions <exceptions>

Expand Down
4 changes: 2 additions & 2 deletions docs/source/logging.rst → docs/source/loggers.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 4 additions & 4 deletions reinforced_lib/rlib.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 0e66698

Please sign in to comment.