Skip to content

encrypted_mode_calculation_param

encrypted_mode_calculation_param

Classes

EncryptedModeCalculatorParam (BaseParam)

Define the encrypted_mode_calulator parameters.

Parameters:

Name Type Description Default
mode {'strict', 'fast', 'balance', 'confusion_opt'}

encrypted mode, default: strict

 'strict'
re_encrypted_rate float or int

numeric number in [0, 1], use when mode equals to 'balance', default: 1

 1
Source code in federatedml/param/encrypted_mode_calculation_param.py 
class EncryptedModeCalculatorParam(BaseParam):
    """
    Define the encrypted_mode_calulator parameters.

    Parameters
    ----------
    mode: {'strict', 'fast', 'balance', 'confusion_opt'}
        encrypted mode, default: strict

    re_encrypted_rate: float or int
        numeric number in [0, 1], use when mode equals to 'balance', default: 1
    """

    def __init__(self, mode="strict", re_encrypted_rate=1):
        self.mode = mode
        self.re_encrypted_rate = re_encrypted_rate

    def check(self):
        descr = "encrypted_mode_calculator param"
        self.mode = self.check_and_change_lower(self.mode,
                                                ["strict", "fast", "balance", "confusion_opt", "confusion_opt_balance"],
                                                descr)

        if self.mode in ["balance", "confusion_opt_balance"]:
            if type(self.re_encrypted_rate).__name__ not in ["int", "long", "float"]:
                raise ValueError("re_encrypted_rate should be a numeric number")

            if not 0.0 <= self.re_encrypted_rate <= 1:
                raise ValueError("re_encrypted_rate should  in [0, 1]")

        return True
__init__(self, mode='strict', re_encrypted_rate=1) special
Source code in federatedml/param/encrypted_mode_calculation_param.py 
def __init__(self, mode="strict", re_encrypted_rate=1):
    self.mode = mode
    self.re_encrypted_rate = re_encrypted_rate
check(self)
Source code in federatedml/param/encrypted_mode_calculation_param.py 
def check(self):
    descr = "encrypted_mode_calculator param"
    self.mode = self.check_and_change_lower(self.mode,
                                            ["strict", "fast", "balance", "confusion_opt", "confusion_opt_balance"],
                                            descr)

    if self.mode in ["balance", "confusion_opt_balance"]:
        if type(self.re_encrypted_rate).__name__ not in ["int", "long", "float"]:
            raise ValueError("re_encrypted_rate should be a numeric number")

        if not 0.0 <= self.re_encrypted_rate <= 1:
            raise ValueError("re_encrypted_rate should  in [0, 1]")

    return True
Last update: 2022-01-27
Back to top