Source code for aepsych.generators.pairwise_optimize_acqf_generator

#!/usr/bin/env python3
# Copyright (c) Facebook, Inc. and its affiliates.
# All rights reserved.

# This source code is licensed under the license found in the
# LICENSE file in the root directory of this source tree.

import warnings

from aepsych.config import Config
from aepsych.generators import OptimizeAcqfGenerator


[docs]class PairwiseOptimizeAcqfGenerator(OptimizeAcqfGenerator):
    """Deprecated. Use OptimizeAcqfGenerator instead."""

    stimuli_per_trial = 2

[docs]    @classmethod
    def from_config(cls, config: Config) -> "OptimizeAcqfGenerator":
        """
        Create an instance of PairwiseOptimizeAcqfGenerator from a configration object.

        Args:
            config (Config): Configuration object containing initialization parameters.

        Returns:
            OptimizeAcqfGenerator: A configured instance of OptimizeAcqfGenerator with specified acquisition function,
            restart and sample parameters, maximum generation time, and stimuli per trial(two in this case).
        """
        warnings.warn(
            "PairwiseOptimizeAcqfGenerator is deprecated. Use OptimizeAcqfGenerator instead.",
            DeprecationWarning,
        )
        return super().from_config(config)