Skip to content

union_param

union_param

Classes

UnionParam (BaseParam)

Define the union method for combining multiple dTables and keep entries with the same id

Parameters:

Name Type Description Default
need_run bool, default True

Indicate if this module needed to be run

 True
allow_missing bool, default False

Whether allow mismatch between feature length and header length in the result. Note that empty tables will always be skipped regardless of this param setting.

 False
keep_duplicate bool, default False

Whether to keep entries with duplicated keys. If set to True, a new id will be generated for duplicated entry in the format {id}_{table_name}.

 False
Source code in federatedml/param/union_param.py 
class UnionParam(BaseParam):
    """
    Define the union method for combining multiple dTables and keep entries with the same id

    Parameters
    ----------
    need_run: bool, default True
        Indicate if this module needed to be run

    allow_missing: bool, default False
        Whether allow mismatch between feature length and header length in the result. Note that empty tables will always be skipped regardless of this param setting.

    keep_duplicate: bool, default False
        Whether to keep entries with duplicated keys. If set to True, a new id will be generated for duplicated entry in the format {id}_{table_name}.
    """

    def __init__(self, need_run=True, allow_missing=False, keep_duplicate=False):
        super().__init__()
        self.need_run = need_run
        self.allow_missing = allow_missing
        self.keep_duplicate = keep_duplicate

    def check(self):
        descr = "union param's "

        if type(self.need_run).__name__ != "bool":
            raise ValueError(
                descr + "need_run {} not supported, should be bool".format(
                    self.need_run))

        if type(self.allow_missing).__name__ != "bool":
            raise ValueError(
                descr + "allow_missing {} not supported, should be bool".format(
                    self.allow_missing))

        if type(self.keep_duplicate).__name__ != "bool":
            raise ValueError(
                descr + "keep_duplicate {} not supported, should be bool".format(
                    self.keep_duplicate))

        LOGGER.info("Finish union parameter check!")
        return True
__init__(self, need_run=True, allow_missing=False, keep_duplicate=False) special
Source code in federatedml/param/union_param.py 
def __init__(self, need_run=True, allow_missing=False, keep_duplicate=False):
    super().__init__()
    self.need_run = need_run
    self.allow_missing = allow_missing
    self.keep_duplicate = keep_duplicate
check(self)
Source code in federatedml/param/union_param.py 
def check(self):
    descr = "union param's "

    if type(self.need_run).__name__ != "bool":
        raise ValueError(
            descr + "need_run {} not supported, should be bool".format(
                self.need_run))

    if type(self.allow_missing).__name__ != "bool":
        raise ValueError(
            descr + "allow_missing {} not supported, should be bool".format(
                self.allow_missing))

    if type(self.keep_duplicate).__name__ != "bool":
        raise ValueError(
            descr + "keep_duplicate {} not supported, should be bool".format(
                self.keep_duplicate))

    LOGGER.info("Finish union parameter check!")
    return True
Last update: 2022-01-27
Back to top