Source code for aepsych.generators.pairwise_sobol_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 .sobol_generator import SobolGenerator


[docs]class PairwiseSobolGenerator(SobolGenerator):
    """Deprecated. Use SobolGenerator instead."""

    stimuli_per_trial = 2

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

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

        Returns:
            SobolGenerator: A configured instance of the generator with specified bounds, dimensionality, random seed, and stimuli per trial(two in this case).
        """
        warnings.warn(
            "PairwiseSobolGenerator is deprecated. Use SobolGenerator instead.",
            DeprecationWarning,
        )
        return super().from_config(config)