Method to_json

pyfair/model/model.py:532–567

Dump the model as JSON string For an example, see the file: "serialized_model.json". Returns ------- str A JSON string representing the model information. Examples -------- >>> model = pyfair.FairModel(name="Insider Threat")

(self)

        return self._model_table

    def to_json(self):
        """Dump the model as JSON string

        For an example, see the file: "serialized_model.json".

        Returns
        -------
        str
            A JSON string representing the model information.

        Examples
        --------
        >>> model = pyfair.FairModel(name="Insider Threat")
        >>> model.bulk_import_data({
        ...     'Loss Event Frequency': {'mean': 90, 'stdev': 100},
        ...     'Loss Magnitude': {'constant': 4000},
        ... })
        ... model.calculate_all)()
        ... json_data = model.to_json()

        """
        # Copy only.
        data = {**self._data_input.get_supplied_values()}
        # Add non-parameter metadata information
        data['name'] = str(self._name)
        data['n_simulations'] = self._n_simulations
        data['random_seed'] = self._random_seed
        data['model_uuid'] = self._model_uuid
        data['type'] = str(self.__class__.__name__)
        data['creation_date'] = self._creation_date
        # Dump as string
        json_data = json.dumps(
            data,
            indent=4,
        )
        return json_data

    def export_params(self):
        """Export params as a dictionary.