#!/usr/bin/env python3
# Copyright (c) Meta Platforms, Inc. and affiliates.
#
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.
# pyre-strict
from collections.abc import Callable
from logging import Logger
from typing import Any
from ax.core.runner import Runner
from ax.runners.synthetic import SyntheticRunner
from ax.storage.json_store.encoders import runner_to_dict
from ax.storage.json_store.registry import (
CORE_DECODER_REGISTRY,
CORE_ENCODER_REGISTRY,
TDecoderRegistry,
)
from ax.storage.utils import stable_hash
from ax.utils.common.logger import get_logger
logger: Logger = get_logger(__name__)
# """
# Mapping of Runner classes to ints.
# All runners will be stored in the same table in the database. When
# saving, we look up the runner subclass in RUNNER_REGISTRY, and store
# the corresponding type field in the database. When loading, we look
# up the type field in REVERSE_RUNNER_REGISTRY, and initialize the
# corresponding runner subclass.
# """
CORE_RUNNER_REGISTRY: dict[type[Runner], int] = {SyntheticRunner: 0}
# pyre-fixme[3]: Return annotation cannot contain `Any`.
[docs]
def register_runner(
runner_cls: type[Runner],
runner_registry: dict[type[Runner], int] = CORE_RUNNER_REGISTRY,
# pyre-fixme[2]: Parameter annotation cannot contain `Any`.
# pyre-fixme[24]: Generic type `type` expects 1 type parameter, use
# `typing.Type` to avoid runtime subscripting errors.
encoder_registry: dict[
type, Callable[[Any], dict[str, Any]]
] = CORE_ENCODER_REGISTRY,
decoder_registry: TDecoderRegistry = CORE_DECODER_REGISTRY,
val: int | None = None,
# pyre-fixme[24]: Generic type `type` expects 1 type parameter, use `typing.Type` to
# avoid runtime subscripting errors.
) -> tuple[
dict[type[Runner], int],
dict[type, Callable[[Any], dict[str, Any]]],
TDecoderRegistry,
]:
"""Add a custom runner class to the SQA and JSON registries.
For the SQA registry, if no int is specified, use a hash of the class name.
"""
registered_val = val or abs(stable_hash(runner_cls.__name__)) % (10**5)
new_runner_registry = {runner_cls: registered_val, **runner_registry}
new_encoder_registry = {runner_cls: runner_to_dict, **encoder_registry}
new_decoder_registry = {runner_cls.__name__: runner_cls, **decoder_registry}
return new_runner_registry, new_encoder_registry, new_decoder_registry
# pyre-fixme[3]: Return annotation cannot contain `Any`.
[docs]
def register_runners(
runner_clss: dict[type[Runner], int | None],
runner_registry: dict[type[Runner], int] = CORE_RUNNER_REGISTRY,
# pyre-fixme[2]: Parameter annotation cannot contain `Any`.
# pyre-fixme[24]: Generic type `type` expects 1 type parameter, use
# `typing.Type` to avoid runtime subscripting errors.
encoder_registry: dict[
type, Callable[[Any], dict[str, Any]]
] = CORE_ENCODER_REGISTRY,
decoder_registry: TDecoderRegistry = CORE_DECODER_REGISTRY,
# pyre-fixme[24]: Generic type `type` expects 1 type parameter, use `typing.Type` to
# avoid runtime subscripting errors.
) -> tuple[
dict[type[Runner], int],
dict[type, Callable[[Any], dict[str, Any]]],
TDecoderRegistry,
]:
"""Add custom runner classes to the SQA and JSON registries.
For the SQA registry, if no int is specified, use a hash of the class name.
"""
new_runner_registry = {
**{
runner_cls: val if val else abs(stable_hash(runner_cls.__name__)) % (10**5)
for runner_cls, val in runner_clss.items()
},
**runner_registry,
}
new_encoder_registry = {
**{runner_cls: runner_to_dict for runner_cls in runner_clss},
**encoder_registry,
}
new_decoder_registry = {
**{runner_cls.__name__: runner_cls for runner_cls in runner_clss},
**decoder_registry,
}
return new_runner_registry, new_encoder_registry, new_decoder_registry
