nemo_gym.server_utils#

Module Contents#

Classes#

GlobalAIOHTTPAsyncClientConfig

ServerClient

BaseServer

All instances of BaseServer are queryable using ServerClient.

ProfilingMiddlewareInputConfig

ProfilingMiddlewareConfig

UvicornLoggingConfig

SimpleServer

HeadServer

Functions#

get_global_aiohttp_client

set_global_aiohttp_client

is_global_aiohttp_client_setup

global_aiohttp_client_exit

request

raise_for_status

initialize_ray

Initialize ray cluster in a process. We store the Ray address in the global config dict so that child processes can connect to it. This avoids the need to start a new Ray cluster in each child process. Note: This function will modify the global config dict - update ray_head_node_address

Data#

_GLOBAL_AIOHTTP_CLIENT

_GLOBAL_AIOHTTP_CLIENT_REQUEST_DEBUG

MAX_NUM_TRIES

DEFAULT_HEAD_SERVER_PORT

ServerStatus

SESSION_ID_KEY

API#

nemo_gym.server_utils._GLOBAL_AIOHTTP_CLIENT: Union[None, aiohttp.ClientSession]#

None

nemo_gym.server_utils._GLOBAL_AIOHTTP_CLIENT_REQUEST_DEBUG: bool#

False

class nemo_gym.server_utils.GlobalAIOHTTPAsyncClientConfig#

Bases: pydantic.BaseModel

global_aiohttp_connector_limit: int#

None

global_aiohttp_connector_limit_per_host: int#

1024

global_aiohttp_client_request_debug: bool#

False

nemo_gym.server_utils.get_global_aiohttp_client(
global_config_dict_parser_config: Optional[nemo_gym.global_config.GlobalConfigDictParserConfig] = None,
global_config_dict_parser_cls: Type[nemo_gym.global_config.GlobalConfigDictParser] = GlobalConfigDictParser,
) → aiohttp.ClientSession#
nemo_gym.server_utils.set_global_aiohttp_client(
cfg: nemo_gym.server_utils.GlobalAIOHTTPAsyncClientConfig,
) → aiohttp.ClientSession#
nemo_gym.server_utils.is_global_aiohttp_client_setup() → bool#
nemo_gym.server_utils.global_aiohttp_client_exit()#
nemo_gym.server_utils.MAX_NUM_TRIES#

3

async nemo_gym.server_utils.request(
method: str,
url: str,
_internal: bool = False,
**kwargs: Unpack[aiohttp.client._RequestOptions],
) → aiohttp.ClientResponse#
async nemo_gym.server_utils.raise_for_status(response: aiohttp.ClientResponse) → None#
nemo_gym.server_utils.DEFAULT_HEAD_SERVER_PORT#

11000

nemo_gym.server_utils.ServerStatus#

None

class nemo_gym.server_utils.ServerClient#

Bases: pydantic.BaseModel

head_server_config: nemo_gym.config_types.BaseServerConfig#

None

global_config_dict: omegaconf.DictConfig#

None

model_config#

‘ConfigDict(…)’

classmethod load_head_server_config() → nemo_gym.config_types.BaseServerConfig#
classmethod load_from_global_config(
head_server_config: Optional[nemo_gym.config_types.BaseServerConfig] = None,
) → nemo_gym.server_utils.ServerClient#
_build_server_base_url(server_config_dict: omegaconf.OmegaConf) → str#
async request(
server_name: str,
url_path: str,
method: str,
**kwargs: Unpack[aiohttp.client._RequestOptions],
) → aiohttp.ClientResponse#
async get(
server_name: str,
url_path: str,
**kwargs: Unpack[aiohttp.client._RequestOptions],
) → aiohttp.ClientResponse#
Parameters:

  • server_name – str The name of the server you are trying to call.

  • url_path – str The URL path in the server you are trying to call e.g. “/v1/responses”.

async post(
server_name: str,
url_path: str,
**kwargs: Unpack[aiohttp.client._RequestOptions],
) → aiohttp.ClientResponse#
Parameters:

  • server_name – str The name of the server you are trying to call.

  • url_path – str The URL path in the server you are trying to call e.g. “/v1/responses”.

poll_for_status(
server_name: str,
) → nemo_gym.server_utils.ServerStatus#
nemo_gym.server_utils.SESSION_ID_KEY#

‘session_id’

class nemo_gym.server_utils.BaseServer#

Bases: pydantic.BaseModel

All instances of BaseServer are queryable using ServerClient.

config: nemo_gym.config_types.BaseRunServerInstanceConfig#

None

classmethod load_config_from_global_config() → nemo_gym.config_types.BaseRunServerInstanceConfig#
class nemo_gym.server_utils.ProfilingMiddlewareInputConfig#

Bases: pydantic.BaseModel

profiling_results_dirpath: Optional[str]#

None

class nemo_gym.server_utils.ProfilingMiddlewareConfig#

Bases: nemo_gym.server_utils.ProfilingMiddlewareInputConfig

profiling_enabled: bool#

False

class nemo_gym.server_utils.UvicornLoggingConfig#

Bases: pydantic.BaseModel

uvicorn_logging_show_200_ok: bool#

False

nemo_gym.server_utils.initialize_ray() → None#

Initialize ray cluster in a process. We store the Ray address in the global config dict so that child processes can connect to it. This avoids the need to start a new Ray cluster in each child process. Note: This function will modify the global config dict - update ray_head_node_address

class nemo_gym.server_utils.SimpleServer#

Bases: nemo_gym.server_utils.BaseServer

server_client: nemo_gym.server_utils.ServerClient#

None

abstractmethod setup_webserver() → fastapi.FastAPI#
get_session_middleware_key() → str#
setup_session_middleware(app: fastapi.FastAPI) → None#
setup_exception_middleware(app: fastapi.FastAPI) → None#
setup_profiling(
app: fastapi.FastAPI,
profiling_config: nemo_gym.server_utils.ProfilingMiddlewareConfig,
) → None#
set_ulimit(target_soft_limit: int = 65535)#
classmethod run_webserver() → None#
class nemo_gym.server_utils.HeadServer#

Bases: nemo_gym.server_utils.BaseServer

config: nemo_gym.config_types.BaseServerConfig#

None

setup_webserver() → fastapi.FastAPI#
classmethod run_webserver() → Tuple[uvicorn.Server, threading.Thread]#
async global_config_dict_yaml() → str#