declearn.communication.NetworkClientConfig

Bases: BuildClientConfig, TomlConfig

TOML-parsable dataclass for network clients' instantiation.

This class enables parsing and bundling arguments to the build_client function from a TOML config file (using the from_toml classmethod) or from keyword arguments (using the from_kwargs one), and calling that function using the build_client method.

Source code in declearn/communication/utils/_build.py

class NetworkClientConfig(BuildClientConfig, TomlConfig):  # type: ignore
    """TOML-parsable dataclass for network clients' instantiation.

    This class enables parsing and bundling arguments to the
    [build_client][declearn.communication.build_client] function
    from a TOML config file (using the `from_toml` classmethod)
    or from keyword arguments (using the `from_kwargs` one), and
    calling that function using the `build_client` method.
    """

    def build_client(self) -> NetworkClient:
        """Build a NetworkClient from the wrapped parameters.

        Returns
        -------
        client: NetworkClient
            NetworkClient communication endpoint instance.
        """
        return self.call()

build_client()

Build a NetworkClient from the wrapped parameters.

Returns:

Name	Type	Description
client	NetworkClient	NetworkClient communication endpoint instance.

Source code in declearn/communication/utils/_build.py

def build_client(self) -> NetworkClient:
    """Build a NetworkClient from the wrapped parameters.

    Returns
    -------
    client: NetworkClient
        NetworkClient communication endpoint instance.
    """
    return self.call()