Module neuralops.experiment_logging.config

Logging configuration dataclass.

Classes

class LoggingConfig (log_level: str = 'INFO',
log_format: str = 'structured',
log_to_console: bool = True,
log_to_file: bool = True,
log_dir: str = './logs',
experiment_name: str = 'experiment',
run_id: str | None = None,
use_timestamp: bool = True,
rank: int | None = None,
rank_specific_logs: bool = True,
use_queue_handler: bool = True,
metrics_enabled: bool = True,
metrics_flush_every: int = 10,
extra_metadata: dict[str, typing.Any] = <factory>)

Expand source code

@dataclass
class LoggingConfig:
    """Complete logging & experiment tracking configuration."""

    log_level: str = "INFO"
    log_format: str = "structured"  # "structured" (JSON lines) or "human"
    log_to_console: bool = True
    log_to_file: bool = True
    log_dir: str = "./logs"
    experiment_name: str = "experiment"
    run_id: str | None = None
    use_timestamp: bool = True
    # Rank-specific and thread-safe logging
    rank: int | None = None  # FIX: Local rank for DDP isolated file logging
    rank_specific_logs: bool = True  # FIX: Enforce isolated rank_{i}.log files per process
    use_queue_handler: bool = True  # FIX: Enforce thread-safe asynchronous logging via QueueHandler
    # Metrics tracking
    metrics_enabled: bool = True
    metrics_flush_every: int = 10  # flush metrics file every N logs
    # Extra metadata added to every event
    extra_metadata: dict[str, Any] = field(default_factory=dict)

Complete logging & experiment tracking configuration.

Instance variables

var experiment_name : str

The type of the None singleton.

var extra_metadata : dict[str, typing.Any]

The type of the None singleton.

var log_dir : str

The type of the None singleton.

var log_format : str

The type of the None singleton.

var log_level : str

The type of the None singleton.

var log_to_console : bool

The type of the None singleton.

var log_to_file : bool

The type of the None singleton.

var metrics_enabled : bool

The type of the None singleton.

var metrics_flush_every : int

The type of the None singleton.

var rank : int | None

The type of the None singleton.

var rank_specific_logs : bool

The type of the None singleton.

var run_id : str | None

The type of the None singleton.

var use_queue_handler : bool

The type of the None singleton.

var use_timestamp : bool

The type of the None singleton.