@@ -93,9 +93,18 @@ class Attack(abc.ABC, metaclass=InputFilter):
9393 attack_params : List [str ] = list ()
9494 _estimator_requirements : Optional [Union [Tuple [Any , ...], Tuple [()]]] = None
9595
96- def __init__ (self , estimator ):
96+ def __init__ (
97+ self ,
98+ estimator ,
99+ tensor_board : Union [str , bool ] = False ,
100+ ):
97101 """
98102 :param estimator: An estimator.
103+ :param tensor_board: Activate summary writer for TensorBoard: Default is `False` and deactivated summary writer.
104+ If `True` save runs/CURRENT_DATETIME_HOSTNAME in current directory. Provide `path` in type
105+ `str` to save in path/CURRENT_DATETIME_HOSTNAME.
106+ Use hierarchical folder structure to compare between runs easily. e.g. pass in ‘runs/exp1’,
107+ ‘runs/exp2’, etc. for each new experiment to compare across them.
99108 """
100109 super ().__init__ ()
101110
@@ -106,6 +115,19 @@ def __init__(self, estimator):
106115 raise EstimatorError (self .__class__ , self .estimator_requirements , estimator )
107116
108117 self ._estimator = estimator
118+ self .tensor_board = tensor_board
119+
120+ if tensor_board :
121+ from tensorboardX import SummaryWriter
122+
123+ if isinstance (tensor_board , str ):
124+ self .summary_writer = SummaryWriter (tensor_board )
125+ else :
126+ self .summary_writer = SummaryWriter ()
127+ else :
128+ self .summary_writer = None
129+
130+ Attack ._check_params (self )
109131
110132 @property
111133 def estimator (self ):
@@ -129,7 +151,9 @@ def set_params(self, **kwargs) -> None:
129151 self ._check_params ()
130152
131153 def _check_params (self ) -> None :
132- pass
154+
155+ if not isinstance (self .tensor_board , (bool , str )):
156+ raise ValueError ("The argument `tensor_board` has to be either of type bool or str." )
133157
134158
135159class EvasionAttack (Attack ):
@@ -305,12 +329,12 @@ def __init__(self, estimator):
305329 @abc .abstractmethod
306330 def infer (self , x : np .ndarray , y : Optional [np .ndarray ] = None , ** kwargs ) -> np .ndarray :
307331 """
308- Infer sensitive properties ( attributes, membership training records) from the targeted estimator. This method
332+ Infer sensitive attributes from the targeted estimator. This method
309333 should be overridden by all concrete inference attack implementations.
310334
311335 :param x: An array with reference inputs to be used in the attack.
312336 :param y: Labels for `x`. This parameter is only used by some of the attacks.
313- :return: An array holding the inferred properties .
337+ :return: An array holding the inferred attribute values .
314338 """
315339 raise NotImplementedError
316340
@@ -334,12 +358,41 @@ def __init__(self, estimator, attack_feature: Union[int, slice] = 0):
334358 @abc .abstractmethod
335359 def infer (self , x : np .ndarray , y : Optional [np .ndarray ] = None , ** kwargs ) -> np .ndarray :
336360 """
337- Infer sensitive properties (attributes, membership training records) from the targeted estimator. This method
361+ Infer sensitive attributes from the targeted estimator. This method
362+ should be overridden by all concrete inference attack implementations.
363+
364+ :param x: An array with reference inputs to be used in the attack.
365+ :param y: Labels for `x`. This parameter is only used by some of the attacks.
366+ :return: An array holding the inferred attribute values.
367+ """
368+ raise NotImplementedError
369+
370+
371+ class MembershipInferenceAttack (InferenceAttack ):
372+ """
373+ Abstract base class for membership inference attack classes.
374+ """
375+
376+ def __init__ (self , estimator : Union ["CLASSIFIER_TYPE" ]):
377+ """
378+ :param estimator: A trained estimator targeted for inference attack.
379+ :type estimator: :class:`.art.estimators.estimator.BaseEstimator`
380+ :param attack_feature: The index of the feature to be attacked.
381+ """
382+ super ().__init__ (estimator )
383+
384+ @abc .abstractmethod
385+ def infer (self , x : np .ndarray , y : Optional [np .ndarray ] = None , ** kwargs ) -> np .ndarray :
386+ """
387+ Infer membership status of samples from the target estimator. This method
338388 should be overridden by all concrete inference attack implementations.
339389
340390 :param x: An array with reference inputs to be used in the attack.
341391 :param y: Labels for `x`. This parameter is only used by some of the attacks.
342- :return: An array holding the inferred properties.
392+ :param probabilities: a boolean indicating whether to return the predicted probabilities per class, or just
393+ the predicted class.
394+ :return: An array holding the inferred membership status (1 indicates member of training set,
395+ 0 indicates non-member) or class probabilities.
343396 """
344397 raise NotImplementedError
345398
0 commit comments