Module config

Source
Expand description

Configuration keys and I/O for hyperactor.

This module declares all config keys (declare_attrs!) and provides helpers to load/save Attrs (from env via from_env, from YAML via from_yaml, and to_yaml). It also re-exports the process-wide layered store under crate::config::global.

For reading/writing the process-global configuration (layered resolution, test overrides), see crate::config::global.

Modules§

global
Global layered configuration store.

Statics§

CHANNEL_MULTIPART
Whether to use multipart encoding for network channel communications.
CHANNEL_NET_RX_BUFFER_FULL_CHECK_INTERVAL
How often to check for full MSPC channel on NetRx.
CODEC_MAX_FRAME_LENGTH
Maximum frame length for codec
CONFIG_ENV_VAR
This is a meta-attribute specifying the environment variable used by the configuration key.
DEFAULT_ENCODING
The default encoding to be used.
ENABLE_CLIENT_SEQ_ASSIGNMENT
Whether to enable client sequence assignment.
HOST_SPAWN_READY_TIMEOUT
Timeout for [Host::spawn] to await proc readiness.
MESSAGE_ACK_EVERY_N_MESSAGES
Number of messages after which to send an acknowledgment
MESSAGE_ACK_TIME_INTERVAL
Message acknowledgment interval
MESSAGE_DELIVERY_TIMEOUT
Message delivery timeout
MESSAGE_LATENCY_SAMPLING_RATE
Sampling rate for logging message latency Set to 0.01 for 1% sampling, 0.1 for 10% sampling, 0.90 for 90% sampling, etc.
MESSAGE_TTL_DEFAULT
Default hop Time-To-Live for message envelopes.
PROCESS_EXIT_TIMEOUT
Timeout used by allocator for stopping a proc.
PYTHON_CONFIG_KEY
This is a meta-attribute specifying the name of the kwarg to pass to monarch.configure() to set the attribute value in the global config.
REMOTE_ALLOCATOR_HEARTBEAT_INTERVAL
Heartbeat interval for remote allocator
SPLIT_MAX_BUFFER_AGE
The maximum time an update can be buffered before being reduced.
SPLIT_MAX_BUFFER_SIZE
Maximum buffer size for split port messages
STOP_ACTOR_TIMEOUT
Timeout used by proc mesh for stopping an actor.

Functions§

from_env
Load configuration from environment variables
from_yaml
Load configuration from a YAML file
to_yaml
Save configuration to a YAML file