Report

Code for automatic report generation.

class sacroml.attacks.report.CustomJSONEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

JSON encoder that can cope with numpy arrays, etc.

Methods

default(o)	If an object is an np.ndarray, convert to list.
encode(o)	Return a JSON string representation of a Python data structure.
iterencode(o[, _one_shot])	Encode the given object and yield each string representation as available.

__init__(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Constructor for JSONEncoder, with sensible defaults.

If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float or None. If skipkeys is True, such items are simply skipped.

If ensure_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII characters escaped. If ensure_ascii is false, the output can contain non-ASCII characters.

If check_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an RecursionError). Otherwise, no such check takes place.

If allow_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.

If sort_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.

If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation.

If specified, separators should be an (item_separator, key_separator) tuple. The default is (’, ‘, ‘: ‘) if indent is None and (‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, you should specify (‘,’, ‘:’) to eliminate whitespace.

If specified, default is a function that gets called for objects that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a TypeError.

default(o: Any)

If an object is an np.ndarray, convert to list.

encode(o)

Return a JSON string representation of a Python data structure.

>>> from json.encoder import JSONEncoder
>>> JSONEncoder().encode({"foo": ["bar", "baz"]})
'{"foo": ["bar", "baz"]}'

iterencode(o, _one_shot=False)

Encode the given object and yield each string representation as available.

For example:

for chunk in JSONEncoder().iterencode(bigobject):
    mysocket.write(chunk)

item_separator = ', '

key_separator = ': '

sacroml.attacks.report.create_lr_report(output: dict) → FPDF

Make a lira membership inference report.

Parameters:

outputdict

Dictionary with the following items:

metadatadict

Dictionary of metadata.

attack_experiment_loggerdict

List of metrics as dictionary items for an experiments. In case of LiRA attack scenario, this will have dictionary items of attack_instance_logger that will have a single metrics dictionary.

Returns:

pdffpdf.FPDF

fpdf document object

sacroml.attacks.report.create_mia_report(attack_output: dict) → FPDF

Make a worst case membership inference report.

Parameters:

attack_outputdict

Dictionary with the following items:

metadatadict

Dictionary of metadata.

attack_experiment_loggerdict

List of metrics as dictionary items for an experiment.

dummy_attack_experiment_loggerdict

List of metrics as dictionary items across dummy experiments.

Returns:

pdffpdf.FPDF

fpdf document object

sacroml.attacks.report.line(pdf: FPDF, text: str, indent: int = 0, border: int = 0, font_size: int = 11, font_style: str = '', font: str = 'arial') → None

Write a standard block.

sacroml.attacks.report.subtitle(pdf: FPDF, text: str, indent: int = 10, border: int = 0, font_size: int = 12, font_style: str = 'B') → None

Write a subtitle block.

sacroml.attacks.report.title(pdf: FPDF, text: str, border: int = 0, font_size: int = 24, font_style: str = 'B') → None

Write a title block.

sacroml.attacks.report.write_json(output: dict, dest: str) → None

Write attack report to JSON.

sacroml.attacks.report.write_pdf(report_dest: str, pdf_report: FPDF) → None

Create pdf and append contents if it already exists.