PyPI - causing - Versions diffs - 2.3.0__tar.gz → 2.4.1__tar.gz - Mend

causing 2.3.0tar.gz → 2.4.1tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of causing might be problematic. Click here for more details.

Files changed (19) hide show

{causing-2.3.0 → causing-2.4.1}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: causing
-Version: 2.3.0
+Version: 2.4.1
 Summary: Causing: CAUSal INterpretation using Graphs
 Home-page: https://github.com/realrate/Causing
 Author: Dr. Holger Bartel
@@ -11,6 +11,12 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
+Requires-Dist: numpy~=1.23
+Requires-Dist: pandas~=1.3
+Requires-Dist: scipy~=1.9
+Requires-Dist: sympy~=1.5
+Requires-Dist: networkx~=2.7
+Requires-Dist: pre-commit
 # Causing: CAUSal INterpretation using Graphs
@@ -23,12 +29,12 @@ effects of a given equation system._
 Get a nice colored graph and immediately understand the causal effects between the variables.
 **Input:** You simply have to put in a dataset and provide an equation system in form of a
-python function. The endogenous variable on the left-hand side are assumed being caused by
+python function. The endogenous variables on the left-hand side are assumed to be caused by
 the variables on the right-hand side of the equation. Thus, you provide the causal structure
 in form of a directed acyclic graph (DAG).
-**Output:** As an output you will get a colored graph of quantified effects acting between
-the model variables. You are able to immediately interpret mediation chains for every
+**Output:** As an output, you will get a colored graph of quantified effects acting between
+the model variables. You can immediately interpret mediation chains for every
 individual observation - even for highly complex nonlinear systems.
 Here is a table relating Causing to other approaches:
@@ -36,10 +42,10 @@ Here is a table relating Causing to other approaches:
 Causing is | Causing is NOT
 --- | ---
 ✅ causal model given | ❌ causal search
-✅ DAG directed acyclic graph | ❌ cyclic, undirected or bidirected graph
+✅ DAG directed acyclic graph | ❌ cyclic, undirected, or bidirected graph
 ✅ latent variables | ❌ just observed / manifest variables
 ✅ individual effects | ❌ just average effects
-✅ direct, total and mediation effects | ❌ just total effects
+✅ direct, total, and mediation effects | ❌ just total effects
 ✅ structural model | ❌ reduced model
 ✅ small and big data | ❌ big data requirement
 ✅ graphical results | ❌ just numerical results
@@ -53,21 +59,21 @@ Causing combines total effects and mediation effects in one single graph that is
 The total effects of a variable on the final variable are shown in the corresponding nodes of the graph. The total effects are split up over their outgoing edges, yielding the mediation effects shown on the edges. Just education has more than one outgoing edge to be interpreted in this way.
-The effects differ from individual to individual. To emphsize this, we talk about individual effects. And the corresponding graph, combining total and mediation effects is called the Imdividual Mediation Effects (IME) graph.
+The effects differ from individual to individual. To emphasize  this, we talk about individual effects. And the corresponding graph, combining total and mediation effects is called the Individual  Mediation Effects (IME) graph.
 ## Software
-Causing is a free software written in _Python 3_. Graphs are generated using _Graphviz_. See dependencies in [setup.py](setup.py). Causing is available under MIT license. See [LICENSE](LICENSE.md "LICENSE").
+Causing is free software written in _Python 3_. Graphs are generated using _Graphviz_. See dependencies in [setup.py](setup.py). Causing is available under MIT license. See [LICENSE](LICENSE.md "LICENSE").
-The software is developed by RealRate, an AI rating agency aiming to re-invent the ratings market by using AI, interpretability and avoiding any conflict of interest. See www.realrate.ai.
+The software is developed by RealRate, an AI rating agency aiming to re-invent the rating market by using AI, interpretability, and avoiding any conflict of interest. See www.realrate.ai.
 When starting `python -m causing.examples example` after cloning / downloading the Causing repository you will find the results  in the _output_ folder. The results are saved in SVG files. The IME files show the individual mediation effects graphs for the respective individual.
 See `causing/examples` for the code generating some examples.
-## Start your own Model
+## Start your Model
-To start your own model, you have to provide the following information, as done in the example code below:
+To start your model, you have to provide the following information, as done in the example code below:
 - Define all your model variables as SymPy symbols.
 - Note that in Sympy some operators are special, e.g. Max() instead of max().
@@ -88,31 +94,31 @@ Y<sub>2</sub> = X<sub>2</sub> + 2 * Y<sub>1</sub><sup>2</sup>
 Y<sub>3</sub> = Y<sub>1</sub> + Y<sub>2</sub>.
-This gives the following graphs. Some notes are in order to understand them:
+This gives the following graphs. Some notes to understand them:
-- The data used consist of 200 observations. They are available for the x variables X<sub>1</sub> and X<sub>2</sub> with mean(X<sub>1</sub>) = 3 and mean(X<sub>2</sub>) = 2. Variables Y<sub>1</sub> and Y<sub>2</sub> are assumed to be latent / unobserved. Y<sub>3</sub> is assumed to be manifest / observed. Therefore, 200 observations are available for Y<sub>3</sub>.
+- The data used consists of 200 observations. They are available for the x variables X<sub>1</sub> and X<sub>2</sub> with mean(X<sub>1</sub>) = 3 and mean(X<sub>2</sub>) = 2. Variables Y<sub>1</sub> and Y<sub>2</sub> are assumed to be latent / unobserved. Y<sub>3</sub> is assumed to be manifest / observed. Therefore, 200 observations are available for Y<sub>3</sub>.
 - To allow for benchmark comparisons, each individual effect is measured with respect to the mean of all observations.
 - Nodes and edges are colored, showing positive (_green_) and negative (_red_) effects they have on the final variable Y<sub>3</sub>.
-- Individual effects are based on the given model. For each individual, however its _own_ exogenous data is put into the given graph function to yield the corresponding endogenous values. The effects are computed at this individual point. Individual effects are shown below just for individual no. 1 out of the 200 observations.
+- Individual effects are based on the given model. For each individual, however, its _own_ exogenous data is put into the given graph function to yield the corresponding endogenous values. The effects are computed at this individual point. Individual effects are shown below just for individual no. 1 out of the 200 observations.
-- Total effects are shown below in the nodes and they are split up over the outgoing edges yielding the Mediation effects shown on the edges. Note however, that just outgoining edges sum up to the node value, incoming edges do not. All effects are effects just on the final variable of interest, assumed here to be Y<sub>3</sub>.
+- Total effects are shown below in the nodes and they are split up over the outgoing edges yielding the Mediation effects shown on the edges. Note, however, that just outgoing edges sum up to the node value, incoming edges do not. All effects are effects just on the final variable of interest, assumed here to be Y<sub>3</sub>.
 ![Individual Mediation Effects (IME)](https://github.com/realrate/Causing/raw/develop/images_readme/IME_1.svg)
-As you can see in the right-most graph for the individual mediation effects (IME), there is one green path starting at X<sub>1</sub> passing through Y<sub>1</sub>, Y<sub>2</sub> and finally ending in Y<sub>3</sub>. This means that X<sub>1</sub> is the main cause for Y<sub>3</sub> taking on a value above average with its effect on Y<sub>3</sub> being +29.81. However, this positive effect is slightly reduced by X<sub>2</sub>. In total, accounting for all exogenous and endogenous effects, Y<sub>3</sub> is +27.07 above average. You can understand at one glance why Y<sub>3</sub> is above average for individual no. 1.
+As you can see in the right-most graph for the individual mediation effects (IME), there is one green path starting at X<sub>1</sub> passing through Y<sub>1</sub>, Y<sub>2</sub>, and finally ending in Y<sub>3</sub>. This means that X<sub>1</sub> is the main cause for Y<sub>3</sub> taking on a value above average with its effect on Y<sub>3</sub> being +29.81. However, this positive effect is slightly reduced by X<sub>2</sub>. In total, accounting for all exogenous and endogenous effects, Y<sub>3</sub> is +27.07 above average. You can understand at one glance why Y<sub>3</sub> is above average for individual no. 1.
 You can find the full source code for this example [here](https://github.com/realrate/Causing/blob/develop/causing/examples/models.py#L16-L45).
 ## 2. Application to Education and Wages
-To dig a bit deeper, here we have a real world example from social sciences. We analyze how the wage earned by young American workers is determined by their educational attainment, family characteristics, and test scores.
+To dig a bit deeper, here we have a real-world example from social sciences. We analyze how the wage earned by young American workers is determined by their educational attainment, family characteristics, and test scores.
-This 5 minute introductory video gives a short overview over Causing and includes this real data example: See [Causing Introduction Video](https://youtu.be/GJLsjSZOk2w "Causing_Introduction_Video").
+This 5-minute introductory video gives a short overview of Causing and includes this real data example: See [Causing Introduction Video](https://youtu.be/GJLsjSZOk2w "Causing_Introduction_Video").
-See here for a detailed analys of the Education and Wages example: [An Application of Causing: Education and Wages](docs/education.md).
+See here for a detailed analysis of the Education and Wages example: [An Application of Causing: Education and Wages](docs/education.md).
 ## 3. Application to Insurance Ratings
@@ -122,21 +128,21 @@ The Causing approach and its formulas together with an application are given in:
 DOI: 10.13140/RG.2.2.31524.83848
 https://www.researchgate.net/publication/339091133
-Note that in this early paper the mediation effects on the final variable of interest are called final effects. Also, while the current Causing version just uses numerically computed effect, that paper uses closed formulas.
+Note that in this early paper the mediation effects on the final variable of interest are called final effects. Also, while the current Causing version just uses numerically computed effects, that paper uses closed formulas.
 The paper proposes simple linear algebra formulas for the causal analysis of equation systems. The effect of one variable on another is the total derivative. It is extended to endogenous system variables. These total effects are identical to the effects used in graph theory and its do-calculus. Further, mediation effects are defined, decomposing the total effect of one variable on a final variable of interest over all its directly caused variables. This allows for an easy but in-depth causal and mediation analysis.
-The equation system provided by the user is represented as a structural neural network (SNN). The network's nodes are represented by the model variables and its edge weights are given by the effects. Unlike classical deep neural networks, we follow a sparse and 'small data' approach. This new methodology is applied to financial strength ratings of insurance companies.
+The equation system provided by the user is represented as a structural neural network (SNN). The network's nodes are represented by the model variables and its edge weights are given by the effects. Unlike classical deep neural networks, we follow a sparse and 'small data' approach. This new methodology is applied to the financial strength ratings of insurance companies.
 > **Keywords:** total derivative, graphical effect, graph theory, do-Calculus, structural neural network, linear Simultaneous Equations Model (SEM), Structural Causal Model (SCM), insurance rating
 ## Award
-RealRate's AI software _Causing_ is a winner of PyTorch AI Hackathon.
+RealRate's AI software _Causing_ is a winner of the PyTorch AI Hackathon.
 <img src="https://github.com/realrate/Causing/raw/develop/images_readme/RealRate_AI_Software_Winner.png">
-We are exited being a winner of the PyTorch AI Hackathon 2020 in the Responsible AI category. This is quite an honor given that more than 2,500 teams submitted their projects.
+We are excited to be a winner of the PyTorch AI Hackathon 2020 in the Responsible AI category. This is quite an honor given that more than 2,500 teams submitted their projects.
 [devpost.com/software/realrate-explainable-ai-for-company-ratings](https://devpost.com/software/realrate-explainable-ai-for-company-ratings "devpost.com/software/realrate-explainable-ai-for-company-ratings").

{causing-2.3.0 → causing-2.4.1}/README.md RENAMED Viewed

@@ -9,12 +9,12 @@ effects of a given equation system._
 Get a nice colored graph and immediately understand the causal effects between the variables.
 **Input:** You simply have to put in a dataset and provide an equation system in form of a
-python function. The endogenous variable on the left-hand side are assumed being caused by
+python function. The endogenous variables on the left-hand side are assumed to be caused by
 the variables on the right-hand side of the equation. Thus, you provide the causal structure
 in form of a directed acyclic graph (DAG).
-**Output:** As an output you will get a colored graph of quantified effects acting between
-the model variables. You are able to immediately interpret mediation chains for every
+**Output:** As an output, you will get a colored graph of quantified effects acting between
+the model variables. You can immediately interpret mediation chains for every
 individual observation - even for highly complex nonlinear systems.
 Here is a table relating Causing to other approaches:
@@ -22,10 +22,10 @@ Here is a table relating Causing to other approaches:
 Causing is | Causing is NOT
 --- | ---
 ✅ causal model given | ❌ causal search
-✅ DAG directed acyclic graph | ❌ cyclic, undirected or bidirected graph
+✅ DAG directed acyclic graph | ❌ cyclic, undirected, or bidirected graph
 ✅ latent variables | ❌ just observed / manifest variables
 ✅ individual effects | ❌ just average effects
-✅ direct, total and mediation effects | ❌ just total effects
+✅ direct, total, and mediation effects | ❌ just total effects
 ✅ structural model | ❌ reduced model
 ✅ small and big data | ❌ big data requirement
 ✅ graphical results | ❌ just numerical results
@@ -39,21 +39,21 @@ Causing combines total effects and mediation effects in one single graph that is
 The total effects of a variable on the final variable are shown in the corresponding nodes of the graph. The total effects are split up over their outgoing edges, yielding the mediation effects shown on the edges. Just education has more than one outgoing edge to be interpreted in this way.
-The effects differ from individual to individual. To emphsize this, we talk about individual effects. And the corresponding graph, combining total and mediation effects is called the Imdividual Mediation Effects (IME) graph.
+The effects differ from individual to individual. To emphasize  this, we talk about individual effects. And the corresponding graph, combining total and mediation effects is called the Individual  Mediation Effects (IME) graph.
 ## Software
-Causing is a free software written in _Python 3_. Graphs are generated using _Graphviz_. See dependencies in [setup.py](setup.py). Causing is available under MIT license. See [LICENSE](LICENSE.md "LICENSE").
+Causing is free software written in _Python 3_. Graphs are generated using _Graphviz_. See dependencies in [setup.py](setup.py). Causing is available under MIT license. See [LICENSE](LICENSE.md "LICENSE").
-The software is developed by RealRate, an AI rating agency aiming to re-invent the ratings market by using AI, interpretability and avoiding any conflict of interest. See www.realrate.ai.
+The software is developed by RealRate, an AI rating agency aiming to re-invent the rating market by using AI, interpretability, and avoiding any conflict of interest. See www.realrate.ai.
 When starting `python -m causing.examples example` after cloning / downloading the Causing repository you will find the results  in the _output_ folder. The results are saved in SVG files. The IME files show the individual mediation effects graphs for the respective individual.
 See `causing/examples` for the code generating some examples.
-## Start your own Model
+## Start your Model
-To start your own model, you have to provide the following information, as done in the example code below:
+To start your model, you have to provide the following information, as done in the example code below:
 - Define all your model variables as SymPy symbols.
 - Note that in Sympy some operators are special, e.g. Max() instead of max().
@@ -74,31 +74,31 @@ Y<sub>2</sub> = X<sub>2</sub> + 2 * Y<sub>1</sub><sup>2</sup>
 Y<sub>3</sub> = Y<sub>1</sub> + Y<sub>2</sub>.
-This gives the following graphs. Some notes are in order to understand them:
+This gives the following graphs. Some notes to understand them:
-- The data used consist of 200 observations. They are available for the x variables X<sub>1</sub> and X<sub>2</sub> with mean(X<sub>1</sub>) = 3 and mean(X<sub>2</sub>) = 2. Variables Y<sub>1</sub> and Y<sub>2</sub> are assumed to be latent / unobserved. Y<sub>3</sub> is assumed to be manifest / observed. Therefore, 200 observations are available for Y<sub>3</sub>.
+- The data used consists of 200 observations. They are available for the x variables X<sub>1</sub> and X<sub>2</sub> with mean(X<sub>1</sub>) = 3 and mean(X<sub>2</sub>) = 2. Variables Y<sub>1</sub> and Y<sub>2</sub> are assumed to be latent / unobserved. Y<sub>3</sub> is assumed to be manifest / observed. Therefore, 200 observations are available for Y<sub>3</sub>.
 - To allow for benchmark comparisons, each individual effect is measured with respect to the mean of all observations.
 - Nodes and edges are colored, showing positive (_green_) and negative (_red_) effects they have on the final variable Y<sub>3</sub>.
-- Individual effects are based on the given model. For each individual, however its _own_ exogenous data is put into the given graph function to yield the corresponding endogenous values. The effects are computed at this individual point. Individual effects are shown below just for individual no. 1 out of the 200 observations.
+- Individual effects are based on the given model. For each individual, however, its _own_ exogenous data is put into the given graph function to yield the corresponding endogenous values. The effects are computed at this individual point. Individual effects are shown below just for individual no. 1 out of the 200 observations.
-- Total effects are shown below in the nodes and they are split up over the outgoing edges yielding the Mediation effects shown on the edges. Note however, that just outgoining edges sum up to the node value, incoming edges do not. All effects are effects just on the final variable of interest, assumed here to be Y<sub>3</sub>.
+- Total effects are shown below in the nodes and they are split up over the outgoing edges yielding the Mediation effects shown on the edges. Note, however, that just outgoing edges sum up to the node value, incoming edges do not. All effects are effects just on the final variable of interest, assumed here to be Y<sub>3</sub>.
 ![Individual Mediation Effects (IME)](https://github.com/realrate/Causing/raw/develop/images_readme/IME_1.svg)
-As you can see in the right-most graph for the individual mediation effects (IME), there is one green path starting at X<sub>1</sub> passing through Y<sub>1</sub>, Y<sub>2</sub> and finally ending in Y<sub>3</sub>. This means that X<sub>1</sub> is the main cause for Y<sub>3</sub> taking on a value above average with its effect on Y<sub>3</sub> being +29.81. However, this positive effect is slightly reduced by X<sub>2</sub>. In total, accounting for all exogenous and endogenous effects, Y<sub>3</sub> is +27.07 above average. You can understand at one glance why Y<sub>3</sub> is above average for individual no. 1.
+As you can see in the right-most graph for the individual mediation effects (IME), there is one green path starting at X<sub>1</sub> passing through Y<sub>1</sub>, Y<sub>2</sub>, and finally ending in Y<sub>3</sub>. This means that X<sub>1</sub> is the main cause for Y<sub>3</sub> taking on a value above average with its effect on Y<sub>3</sub> being +29.81. However, this positive effect is slightly reduced by X<sub>2</sub>. In total, accounting for all exogenous and endogenous effects, Y<sub>3</sub> is +27.07 above average. You can understand at one glance why Y<sub>3</sub> is above average for individual no. 1.
 You can find the full source code for this example [here](https://github.com/realrate/Causing/blob/develop/causing/examples/models.py#L16-L45).
 ## 2. Application to Education and Wages
-To dig a bit deeper, here we have a real world example from social sciences. We analyze how the wage earned by young American workers is determined by their educational attainment, family characteristics, and test scores.
+To dig a bit deeper, here we have a real-world example from social sciences. We analyze how the wage earned by young American workers is determined by their educational attainment, family characteristics, and test scores.
-This 5 minute introductory video gives a short overview over Causing and includes this real data example: See [Causing Introduction Video](https://youtu.be/GJLsjSZOk2w "Causing_Introduction_Video").
+This 5-minute introductory video gives a short overview of Causing and includes this real data example: See [Causing Introduction Video](https://youtu.be/GJLsjSZOk2w "Causing_Introduction_Video").
-See here for a detailed analys of the Education and Wages example: [An Application of Causing: Education and Wages](docs/education.md).
+See here for a detailed analysis of the Education and Wages example: [An Application of Causing: Education and Wages](docs/education.md).
 ## 3. Application to Insurance Ratings
@@ -108,21 +108,21 @@ The Causing approach and its formulas together with an application are given in:
 DOI: 10.13140/RG.2.2.31524.83848
 https://www.researchgate.net/publication/339091133
-Note that in this early paper the mediation effects on the final variable of interest are called final effects. Also, while the current Causing version just uses numerically computed effect, that paper uses closed formulas.
+Note that in this early paper the mediation effects on the final variable of interest are called final effects. Also, while the current Causing version just uses numerically computed effects, that paper uses closed formulas.
 The paper proposes simple linear algebra formulas for the causal analysis of equation systems. The effect of one variable on another is the total derivative. It is extended to endogenous system variables. These total effects are identical to the effects used in graph theory and its do-calculus. Further, mediation effects are defined, decomposing the total effect of one variable on a final variable of interest over all its directly caused variables. This allows for an easy but in-depth causal and mediation analysis.
-The equation system provided by the user is represented as a structural neural network (SNN). The network's nodes are represented by the model variables and its edge weights are given by the effects. Unlike classical deep neural networks, we follow a sparse and 'small data' approach. This new methodology is applied to financial strength ratings of insurance companies.
+The equation system provided by the user is represented as a structural neural network (SNN). The network's nodes are represented by the model variables and its edge weights are given by the effects. Unlike classical deep neural networks, we follow a sparse and 'small data' approach. This new methodology is applied to the financial strength ratings of insurance companies.
 > **Keywords:** total derivative, graphical effect, graph theory, do-Calculus, structural neural network, linear Simultaneous Equations Model (SEM), Structural Causal Model (SCM), insurance rating
 ## Award
-RealRate's AI software _Causing_ is a winner of PyTorch AI Hackathon.
+RealRate's AI software _Causing_ is a winner of the PyTorch AI Hackathon.
 <img src="https://github.com/realrate/Causing/raw/develop/images_readme/RealRate_AI_Software_Winner.png">
-We are exited being a winner of the PyTorch AI Hackathon 2020 in the Responsible AI category. This is quite an honor given that more than 2,500 teams submitted their projects.
+We are excited to be a winner of the PyTorch AI Hackathon 2020 in the Responsible AI category. This is quite an honor given that more than 2,500 teams submitted their projects.
 [devpost.com/software/realrate-explainable-ai-for-company-ratings](https://devpost.com/software/realrate-explainable-ai-for-company-ratings "devpost.com/software/realrate-explainable-ai-for-company-ratings").

{causing-2.3.0 → causing-2.4.1}/causing/graph.py RENAMED Viewed

@@ -69,8 +69,8 @@ def save_graph(path: Path, graph_dot):
     svg_code = subprocess.check_output(
         [DOT_COMMAND, "-Tsvg"], input=graph_dot, encoding="utf-8"
     )
-    if dot_version()[0] < 3:
-        svg_code = fix_svg_scale(svg_code)
+    # if dot_version()[0] < 3:
+    #     svg_code = fix_svg_scale(svg_code)
     with open(path, "w") as f:
         f.write(svg_code)
@@ -149,6 +149,7 @@ def graph_to_dot(
     graph_options_str=GRAPH_OPTIONS_STR,
     in_percent=False,
     min_sig_figures=3,
+    cutoff=0.0001,
 ):
     dot_str = "digraph {" + graph_options_str
     max_val = max(
@@ -157,13 +158,21 @@ def graph_to_dot(
     )
     for node, data in g.nodes(data=True):
-        eff_str = utils.fmt_min_sig(data["effect"], min_sig_figures, percent=in_percent)
+        eff_str = utils.fmt_min_sig(
+            data["effect"] if abs(data["effect"]) > cutoff else 0,
+            min_sig_figures,
+            percent=in_percent,
+        )
         label = data.get("label", node).replace("\n", r"\n") + r"\n" + eff_str
         col_str = color(data["effect"], max_val, palette=node_palette)
         dot_str += f'    "{node}"[label = "{label}" fillcolor="{col_str}"]\n'
     for from_node, to_node, data in g.edges(data=True):
-        eff_str = utils.fmt_min_sig(data["effect"], min_sig_figures, percent=in_percent)
+        eff_str = utils.fmt_min_sig(
+            data["effect"] if abs(data["effect"]) > cutoff else 0,
+            min_sig_figures,
+            percent=in_percent,
+        )
         col_str = color(data["effect"], max_val, palette=edge_palette)
         penwidth = color(data["effect"], max_val, palette=pen_width_palette)
         dot_str += f'    "{from_node}" -> "{to_node}" [label="{eff_str}" color="{col_str}" penwidth="{penwidth}"]\n'

{causing-2.3.0 → causing-2.4.1}/causing/model.py RENAMED Viewed

@@ -1,4 +1,5 @@
 from __future__ import annotations
 from dataclasses import dataclass, field
 from typing import Iterable, Callable
 from functools import cached_property
@@ -8,6 +9,10 @@ import sympy
 import numpy as np
+class NumericModelError(Exception):
+    pass
 @dataclass
 class Model:
@@ -42,6 +47,7 @@ class Model:
             self.graph.add_node(var)
         self.trans_graph = networkx.transitive_closure(self.graph, reflexive=True)
+    @np.errstate(all="raise")
     def compute(
         self,
         xdat: np.array,
@@ -77,15 +83,36 @@ class Model:
                     eq_inputs[:, fixed_from_ind] = fixed_vals
                 try:
+                    # print(f"Comuting variable: {self.yvars[i]}")
+                    # yhat[i] = np.array(
+                    #     [eq(*eq_in, *parameters.values()) for eq_in in eq_inputs],
+                    #     dtype=np.float64,
+                    # )
+                    computed_yvars = []
+                    for eq_in in eq_inputs:
+                        try:
+                            computed_yvars.append(eq(*eq_in, *parameters.values()))
+                        except FloatingPointError:
+                            # Floating Point Error for self.yvars[i]
+                            # Adding 0.0 to overcome this.
+                            computed_yvars.append(0.0)
                     yhat[i] = np.array(
-                        [eq(*eq_in, *parameters.values()) for eq_in in eq_inputs],
+                        computed_yvars,
                         dtype=np.float64,
                     )
                 except Exception as e:
-                    print(
+                    # for eq_in in eq_inputs:
+                    #     print("--", self.yvars[i])
+                    #     for var, val in zip(
+                    #         self.vars + list(parameters.keys()),
+                    #         list(eq_in) + list(parameters.values()),
+                    #     ):
+                    #         print(var, "=", val)
+                    #     eq(*eq_in, *parameters.values())
+                    raise NumericModelError(
                         f"Failed to compute model value for yvar {self.yvars[i]}: {e}"
-                    )
-                    raise
+                    ) from e
         assert yhat.shape == (self.ndim, tau)
         return yhat

{causing-2.3.0 → causing-2.4.1}/causing/utils.py RENAMED Viewed

@@ -11,7 +11,7 @@ def round_sig(x, sig=2) -> float:
     """Round x to the given number of significant figures"""
     if x == 0 or not np.isfinite(x):
         return x
-    return round(x, sig - int(floor(log10(abs(x)))) - 1)
+    return round(x, sig - int(floor(log10(abs(x)))) + 1)
 def round_sig_recursive(x, sig=2):
@@ -37,6 +37,11 @@ def round_sig_recursive(x, sig=2):
 class MatrixEncoder(json.JSONEncoder):
     def default(self, obj):
+        # allow serialization of numpy scalars
+        if isinstance(obj, np.integer):
+            return int(obj)
+        if isinstance(obj, np.floating):
+            return float(obj)
         # avoid importing pytorch for isinstance check
         if isinstance(obj, np.ndarray) or type(obj).__name__ == "Tensor":
             return obj.tolist()
@@ -61,11 +66,12 @@ def fmt_min_sig(x, min_sig_figures=3, percent=False, percent_spacer=""):
     if not math.isfinite(x):
         return str(x)
     if x == 0:
-        return "0"
-    if percent:
-        x *= 100
-    show_dec = max(-math.floor(math.log10(abs(x)) + 1) + min_sig_figures, 0)
-    num = locale.format_string("%." + str(show_dec) + "f", x, grouping=True)
+        num = "0"
+    else:
+        if percent:
+            x *= 100
+        show_dec = max(-math.floor(math.log10(abs(x)) + 1) + min_sig_figures, 0)
+        num = locale.format_string("%." + str(show_dec) + "f", x, grouping=True)
     if percent:
         num += percent_spacer + "%"
     return num

{causing-2.3.0 → causing-2.4.1}/causing.egg-info/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: causing
-Version: 2.3.0
+Version: 2.4.1
 Summary: Causing: CAUSal INterpretation using Graphs
 Home-page: https://github.com/realrate/Causing
 Author: Dr. Holger Bartel
@@ -11,6 +11,12 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
+Requires-Dist: numpy~=1.23
+Requires-Dist: pandas~=1.3
+Requires-Dist: scipy~=1.9
+Requires-Dist: sympy~=1.5
+Requires-Dist: networkx~=2.7
+Requires-Dist: pre-commit
 # Causing: CAUSal INterpretation using Graphs
@@ -23,12 +29,12 @@ effects of a given equation system._
 Get a nice colored graph and immediately understand the causal effects between the variables.
 **Input:** You simply have to put in a dataset and provide an equation system in form of a
-python function. The endogenous variable on the left-hand side are assumed being caused by
+python function. The endogenous variables on the left-hand side are assumed to be caused by
 the variables on the right-hand side of the equation. Thus, you provide the causal structure
 in form of a directed acyclic graph (DAG).
-**Output:** As an output you will get a colored graph of quantified effects acting between
-the model variables. You are able to immediately interpret mediation chains for every
+**Output:** As an output, you will get a colored graph of quantified effects acting between
+the model variables. You can immediately interpret mediation chains for every
 individual observation - even for highly complex nonlinear systems.
 Here is a table relating Causing to other approaches:
@@ -36,10 +42,10 @@ Here is a table relating Causing to other approaches:
 Causing is | Causing is NOT
 --- | ---
 ✅ causal model given | ❌ causal search
-✅ DAG directed acyclic graph | ❌ cyclic, undirected or bidirected graph
+✅ DAG directed acyclic graph | ❌ cyclic, undirected, or bidirected graph
 ✅ latent variables | ❌ just observed / manifest variables
 ✅ individual effects | ❌ just average effects
-✅ direct, total and mediation effects | ❌ just total effects
+✅ direct, total, and mediation effects | ❌ just total effects
 ✅ structural model | ❌ reduced model
 ✅ small and big data | ❌ big data requirement
 ✅ graphical results | ❌ just numerical results
@@ -53,21 +59,21 @@ Causing combines total effects and mediation effects in one single graph that is
 The total effects of a variable on the final variable are shown in the corresponding nodes of the graph. The total effects are split up over their outgoing edges, yielding the mediation effects shown on the edges. Just education has more than one outgoing edge to be interpreted in this way.
-The effects differ from individual to individual. To emphsize this, we talk about individual effects. And the corresponding graph, combining total and mediation effects is called the Imdividual Mediation Effects (IME) graph.
+The effects differ from individual to individual. To emphasize  this, we talk about individual effects. And the corresponding graph, combining total and mediation effects is called the Individual  Mediation Effects (IME) graph.
 ## Software
-Causing is a free software written in _Python 3_. Graphs are generated using _Graphviz_. See dependencies in [setup.py](setup.py). Causing is available under MIT license. See [LICENSE](LICENSE.md "LICENSE").
+Causing is free software written in _Python 3_. Graphs are generated using _Graphviz_. See dependencies in [setup.py](setup.py). Causing is available under MIT license. See [LICENSE](LICENSE.md "LICENSE").
-The software is developed by RealRate, an AI rating agency aiming to re-invent the ratings market by using AI, interpretability and avoiding any conflict of interest. See www.realrate.ai.
+The software is developed by RealRate, an AI rating agency aiming to re-invent the rating market by using AI, interpretability, and avoiding any conflict of interest. See www.realrate.ai.
 When starting `python -m causing.examples example` after cloning / downloading the Causing repository you will find the results  in the _output_ folder. The results are saved in SVG files. The IME files show the individual mediation effects graphs for the respective individual.
 See `causing/examples` for the code generating some examples.
-## Start your own Model
+## Start your Model
-To start your own model, you have to provide the following information, as done in the example code below:
+To start your model, you have to provide the following information, as done in the example code below:
 - Define all your model variables as SymPy symbols.
 - Note that in Sympy some operators are special, e.g. Max() instead of max().
@@ -88,31 +94,31 @@ Y<sub>2</sub> = X<sub>2</sub> + 2 * Y<sub>1</sub><sup>2</sup>
 Y<sub>3</sub> = Y<sub>1</sub> + Y<sub>2</sub>.
-This gives the following graphs. Some notes are in order to understand them:
+This gives the following graphs. Some notes to understand them:
-- The data used consist of 200 observations. They are available for the x variables X<sub>1</sub> and X<sub>2</sub> with mean(X<sub>1</sub>) = 3 and mean(X<sub>2</sub>) = 2. Variables Y<sub>1</sub> and Y<sub>2</sub> are assumed to be latent / unobserved. Y<sub>3</sub> is assumed to be manifest / observed. Therefore, 200 observations are available for Y<sub>3</sub>.
+- The data used consists of 200 observations. They are available for the x variables X<sub>1</sub> and X<sub>2</sub> with mean(X<sub>1</sub>) = 3 and mean(X<sub>2</sub>) = 2. Variables Y<sub>1</sub> and Y<sub>2</sub> are assumed to be latent / unobserved. Y<sub>3</sub> is assumed to be manifest / observed. Therefore, 200 observations are available for Y<sub>3</sub>.
 - To allow for benchmark comparisons, each individual effect is measured with respect to the mean of all observations.
 - Nodes and edges are colored, showing positive (_green_) and negative (_red_) effects they have on the final variable Y<sub>3</sub>.
-- Individual effects are based on the given model. For each individual, however its _own_ exogenous data is put into the given graph function to yield the corresponding endogenous values. The effects are computed at this individual point. Individual effects are shown below just for individual no. 1 out of the 200 observations.
+- Individual effects are based on the given model. For each individual, however, its _own_ exogenous data is put into the given graph function to yield the corresponding endogenous values. The effects are computed at this individual point. Individual effects are shown below just for individual no. 1 out of the 200 observations.
-- Total effects are shown below in the nodes and they are split up over the outgoing edges yielding the Mediation effects shown on the edges. Note however, that just outgoining edges sum up to the node value, incoming edges do not. All effects are effects just on the final variable of interest, assumed here to be Y<sub>3</sub>.
+- Total effects are shown below in the nodes and they are split up over the outgoing edges yielding the Mediation effects shown on the edges. Note, however, that just outgoing edges sum up to the node value, incoming edges do not. All effects are effects just on the final variable of interest, assumed here to be Y<sub>3</sub>.
 ![Individual Mediation Effects (IME)](https://github.com/realrate/Causing/raw/develop/images_readme/IME_1.svg)
-As you can see in the right-most graph for the individual mediation effects (IME), there is one green path starting at X<sub>1</sub> passing through Y<sub>1</sub>, Y<sub>2</sub> and finally ending in Y<sub>3</sub>. This means that X<sub>1</sub> is the main cause for Y<sub>3</sub> taking on a value above average with its effect on Y<sub>3</sub> being +29.81. However, this positive effect is slightly reduced by X<sub>2</sub>. In total, accounting for all exogenous and endogenous effects, Y<sub>3</sub> is +27.07 above average. You can understand at one glance why Y<sub>3</sub> is above average for individual no. 1.
+As you can see in the right-most graph for the individual mediation effects (IME), there is one green path starting at X<sub>1</sub> passing through Y<sub>1</sub>, Y<sub>2</sub>, and finally ending in Y<sub>3</sub>. This means that X<sub>1</sub> is the main cause for Y<sub>3</sub> taking on a value above average with its effect on Y<sub>3</sub> being +29.81. However, this positive effect is slightly reduced by X<sub>2</sub>. In total, accounting for all exogenous and endogenous effects, Y<sub>3</sub> is +27.07 above average. You can understand at one glance why Y<sub>3</sub> is above average for individual no. 1.
 You can find the full source code for this example [here](https://github.com/realrate/Causing/blob/develop/causing/examples/models.py#L16-L45).
 ## 2. Application to Education and Wages
-To dig a bit deeper, here we have a real world example from social sciences. We analyze how the wage earned by young American workers is determined by their educational attainment, family characteristics, and test scores.
+To dig a bit deeper, here we have a real-world example from social sciences. We analyze how the wage earned by young American workers is determined by their educational attainment, family characteristics, and test scores.
-This 5 minute introductory video gives a short overview over Causing and includes this real data example: See [Causing Introduction Video](https://youtu.be/GJLsjSZOk2w "Causing_Introduction_Video").
+This 5-minute introductory video gives a short overview of Causing and includes this real data example: See [Causing Introduction Video](https://youtu.be/GJLsjSZOk2w "Causing_Introduction_Video").
-See here for a detailed analys of the Education and Wages example: [An Application of Causing: Education and Wages](docs/education.md).
+See here for a detailed analysis of the Education and Wages example: [An Application of Causing: Education and Wages](docs/education.md).
 ## 3. Application to Insurance Ratings
@@ -122,21 +128,21 @@ The Causing approach and its formulas together with an application are given in:
 DOI: 10.13140/RG.2.2.31524.83848
 https://www.researchgate.net/publication/339091133
-Note that in this early paper the mediation effects on the final variable of interest are called final effects. Also, while the current Causing version just uses numerically computed effect, that paper uses closed formulas.
+Note that in this early paper the mediation effects on the final variable of interest are called final effects. Also, while the current Causing version just uses numerically computed effects, that paper uses closed formulas.
 The paper proposes simple linear algebra formulas for the causal analysis of equation systems. The effect of one variable on another is the total derivative. It is extended to endogenous system variables. These total effects are identical to the effects used in graph theory and its do-calculus. Further, mediation effects are defined, decomposing the total effect of one variable on a final variable of interest over all its directly caused variables. This allows for an easy but in-depth causal and mediation analysis.
-The equation system provided by the user is represented as a structural neural network (SNN). The network's nodes are represented by the model variables and its edge weights are given by the effects. Unlike classical deep neural networks, we follow a sparse and 'small data' approach. This new methodology is applied to financial strength ratings of insurance companies.
+The equation system provided by the user is represented as a structural neural network (SNN). The network's nodes are represented by the model variables and its edge weights are given by the effects. Unlike classical deep neural networks, we follow a sparse and 'small data' approach. This new methodology is applied to the financial strength ratings of insurance companies.
 > **Keywords:** total derivative, graphical effect, graph theory, do-Calculus, structural neural network, linear Simultaneous Equations Model (SEM), Structural Causal Model (SCM), insurance rating
 ## Award
-RealRate's AI software _Causing_ is a winner of PyTorch AI Hackathon.
+RealRate's AI software _Causing_ is a winner of the PyTorch AI Hackathon.
 <img src="https://github.com/realrate/Causing/raw/develop/images_readme/RealRate_AI_Software_Winner.png">
-We are exited being a winner of the PyTorch AI Hackathon 2020 in the Responsible AI category. This is quite an honor given that more than 2,500 teams submitted their projects.
+We are excited to be a winner of the PyTorch AI Hackathon 2020 in the Responsible AI category. This is quite an honor given that more than 2,500 teams submitted their projects.
 [devpost.com/software/realrate-explainable-ai-for-company-ratings](https://devpost.com/software/realrate-explainable-ai-for-company-ratings "devpost.com/software/realrate-explainable-ai-for-company-ratings").

{causing-2.3.0 → causing-2.4.1}/setup.py RENAMED Viewed

@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 setuptools.setup(
     name="causing",
-    version="2.3.0",
+    version="2.4.1",
     author="Dr. Holger Bartel",
     author_email="holger.bartel@realrate.ai",
     description="Causing: CAUSal INterpretation using Graphs",