Skip to content

client.settings

Classes:

Name Description
Settings

Client settings.

Classes

Settings

Client settings.

Returned by:

Attributes:

Name Type Description
COMMUNICATION_MODULE str

Communication module of the client. Default: dlr.fl.client.communication.Communication
FL_DEMONSTRATOR_BASE_URL str

Base URL of the FL Demonstrator server. Default: http://localhost:8000
FL_DEMONSTRATOR_TRAINING_SCRIPT_EXECUTOR str

Path to the script executor. Default: python
FL_DEMONSTRATOR_TRAINING_SCRIPT_PATH str

Path to the training script. Default: src/main.py
FL_DEMONSTRATOR_TRAINING_WORKING_DIRETORY str

Working directory for the training script. Default: .
MAIN_MODULE str

Main entry point of the client server. Default: dlr.fl.client.__main__.default_main
SERVER_HOST str

Client server hostname. Default: 0.0.0.0
SERVER_PORT int

Client server port. Default: 8101
Source code in dlr/fl/client/settings.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class Settings:
    """
    Client settings.
    """

    FL_DEMONSTRATOR_BASE_URL: str = environ.get("FL_DEMONSTRATOR_BASE_URL", "http://localhost:8000")
    """Base URL of the FL Demonstrator server. Default: `http://localhost:8000`"""
    FL_DEMONSTRATOR_TRAINING_SCRIPT_EXECUTOR: str = environ.get("FL_DEMONSTRATOR_TRAINING_SCRIPT_EXECUTOR", "python")
    """Path to the script executor. Default: `python`"""
    FL_DEMONSTRATOR_TRAINING_SCRIPT_PATH: str = environ.get("FL_DEMONSTRATOR_TRAINING_SCRIPT_PATH", "src/main.py")
    """Path to the training script. Default: `src/main.py`"""
    FL_DEMONSTRATOR_TRAINING_WORKING_DIRETORY: str = environ.get("FL_DEMONSTRATOR_TRAINING_WORKING_DIRETORY", ".")
    """Working directory for the training script. Default: `.`"""

    SERVER_HOST: str = environ.get("FL_CLIENT_SERVER_HOST", "0.0.0.0")
    """Client server hostname. Default: `0.0.0.0`"""
    SERVER_PORT: int = int(environ.get("FL_CLIENT_SERVER_PORT", "8101"))
    """Client server port. Default: `8101`"""

    MAIN_MODULE: str = "dlr.fl.client.__main__.default_main"
    """Main entry point of the client server. Default: `dlr.fl.client.__main__.default_main`"""
    COMMUNICATION_MODULE: str = "dlr.fl.client.communication.Communication"
    """Communication module of the client. Default: `dlr.fl.client.communication.Communication`"""

Attributes

COMMUNICATION_MODULE class-attribute instance-attribute 
COMMUNICATION_MODULE: str = 'dlr.fl.client.communication.Communication'

Communication module of the client. Default: dlr.fl.client.communication.Communication

FL_DEMONSTRATOR_BASE_URL class-attribute instance-attribute 
FL_DEMONSTRATOR_BASE_URL: str = get('FL_DEMONSTRATOR_BASE_URL', 'http://localhost:8000')

Base URL of the FL Demonstrator server. Default: http://localhost:8000

FL_DEMONSTRATOR_TRAINING_SCRIPT_EXECUTOR class-attribute instance-attribute 
FL_DEMONSTRATOR_TRAINING_SCRIPT_EXECUTOR: str = get('FL_DEMONSTRATOR_TRAINING_SCRIPT_EXECUTOR', 'python')

Path to the script executor. Default: python

FL_DEMONSTRATOR_TRAINING_SCRIPT_PATH class-attribute instance-attribute 
FL_DEMONSTRATOR_TRAINING_SCRIPT_PATH: str = get('FL_DEMONSTRATOR_TRAINING_SCRIPT_PATH', 'src/main.py')

Path to the training script. Default: src/main.py

FL_DEMONSTRATOR_TRAINING_WORKING_DIRETORY class-attribute instance-attribute 
FL_DEMONSTRATOR_TRAINING_WORKING_DIRETORY: str = get('FL_DEMONSTRATOR_TRAINING_WORKING_DIRETORY', '.')

Working directory for the training script. Default: .

MAIN_MODULE class-attribute instance-attribute 
MAIN_MODULE: str = 'dlr.fl.client.__main__.default_main'

Main entry point of the client server. Default: dlr.fl.client.__main__.default_main

SERVER_HOST class-attribute instance-attribute 
SERVER_HOST: str = get('FL_CLIENT_SERVER_HOST', '0.0.0.0')

Client server hostname. Default: 0.0.0.0

SERVER_PORT class-attribute instance-attribute 
SERVER_PORT: int = int(get('FL_CLIENT_SERVER_PORT', '8101'))

Client server port. Default: 8101