diff --git a/README.md b/README.md index 5dc7429..49e92db 100644 --- a/README.md +++ b/README.md @@ -58,9 +58,9 @@ Need to use proper file name. ```bash # inside project root folder -pip install ./dist/torchvinecopulib-2024.4.2-py3-none-any.whl +pip install ./dist/torchvinecopulib-2024.5.0-py3-none-any.whl # or -pip install ./dist/torchvinecopulib-2024.4.2.tar.gz +pip install ./dist/torchvinecopulib-2024.5.0.tar.gz ``` ## Examples diff --git a/dist/torchvinecopulib-2024.4.2.tar.gz b/dist/torchvinecopulib-2024.4.2.tar.gz deleted file mode 100644 index 8a4870f..0000000 Binary files a/dist/torchvinecopulib-2024.4.2.tar.gz and /dev/null differ diff --git a/dist/torchvinecopulib-2024.4.2-py3-none-any.whl b/dist/torchvinecopulib-2024.5.0-py3-none-any.whl similarity index 53% rename from dist/torchvinecopulib-2024.4.2-py3-none-any.whl rename to dist/torchvinecopulib-2024.5.0-py3-none-any.whl index 4335c3d..af10ddd 100644 Binary files a/dist/torchvinecopulib-2024.4.2-py3-none-any.whl and b/dist/torchvinecopulib-2024.5.0-py3-none-any.whl differ diff --git a/dist/torchvinecopulib-2024.5.0.tar.gz b/dist/torchvinecopulib-2024.5.0.tar.gz new file mode 100644 index 0000000..afa360d Binary files /dev/null and b/dist/torchvinecopulib-2024.5.0.tar.gz differ diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo index 4d3aa4a..85b2b91 100644 --- a/docs/_build/html/.buildinfo +++ b/docs/_build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 587bff00933dfee28f32f72b05a3d1f8 +config: 4319608de6cdeb498646305aaa6ec36f tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html index 3107ceb..aeec5c8 100644 --- a/docs/_build/html/_modules/index.html +++ b/docs/_build/html/_modules/index.html @@ -5,7 +5,7 @@ - Overview: module code - torchvinecopulib 2024.4.2 documentation + Overview: module code - torchvinecopulib 2024.5.0 documentation @@ -124,7 +124,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -147,7 +147,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation
-
+
diff --git a/docs/_build/html/_modules/torchvinecopulib/bicop/_data_bcp.html b/docs/_build/html/_modules/torchvinecopulib/bicop/_data_bcp.html index 23dddab..89ba7e3 100644 --- a/docs/_build/html/_modules/torchvinecopulib/bicop/_data_bcp.html +++ b/docs/_build/html/_modules/torchvinecopulib/bicop/_data_bcp.html @@ -5,7 +5,7 @@ - torchvinecopulib.bicop._data_bcp - torchvinecopulib 2024.4.2 documentation + torchvinecopulib.bicop._data_bcp - torchvinecopulib 2024.5.0 documentation @@ -124,7 +124,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -147,7 +147,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -517,7 +517,7 @@

Source code for torchvinecopulib.bicop._data_bcp

-
+
diff --git a/docs/_build/html/_modules/torchvinecopulib/bicop/_factory_bcp.html b/docs/_build/html/_modules/torchvinecopulib/bicop/_factory_bcp.html index 0440548..840fc73 100644 --- a/docs/_build/html/_modules/torchvinecopulib/bicop/_factory_bcp.html +++ b/docs/_build/html/_modules/torchvinecopulib/bicop/_factory_bcp.html @@ -5,7 +5,7 @@ - torchvinecopulib.bicop._factory_bcp - torchvinecopulib 2024.4.2 documentation + torchvinecopulib.bicop._factory_bcp - torchvinecopulib 2024.5.0 documentation @@ -124,7 +124,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -147,7 +147,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -227,7 +227,7 @@

Source code for torchvinecopulib.bicop._factory_bcp

:type obs_bcp: torch.Tensor :param tau: Kendall's tau of the observations, defaults to None for the function to estimate :type tau: float, optional - :param thresh_trunc: threshold of Kendall's tau independence test, below which we reject independent bicop, defaults to 0.1 + :param thresh_trunc: threshold of Kendall's tau independence test, below which we reject independent bicop, defaults to 0.05 :type thresh_trunc: float, optional :param mtd_fit: parameter estimation method, either 'itau' (inverse of tau) or 'mle' (maximum likelihood estimation); defaults to "itau" @@ -348,7 +348,7 @@

Source code for torchvinecopulib.bicop._factory_bcp

+
diff --git a/docs/_build/html/_modules/torchvinecopulib/util.html b/docs/_build/html/_modules/torchvinecopulib/util.html index acf0729..b7c90e1 100644 --- a/docs/_build/html/_modules/torchvinecopulib/util.html +++ b/docs/_build/html/_modules/torchvinecopulib/util.html @@ -5,7 +5,7 @@ - torchvinecopulib.util - torchvinecopulib 2024.4.2 documentation + torchvinecopulib.util - torchvinecopulib 2024.5.0 documentation @@ -124,7 +124,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -147,7 +147,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -197,9 +197,10 @@

Source code for torchvinecopulib.util

 import math
 from enum import Enum
 from functools import partial
+from itertools import product
 
 import torch
-from scipy.stats import t, kendalltau
+from scipy.stats import kendalltau, t
 
 __all__ = [
     "ENUM_FUNC_BIDEP",
@@ -366,49 +367,50 @@ 
Source code for torchvinecopulib.util
 def wasserstein_dist_ind(
     x: torch.Tensor,
     y: torch.Tensor,
-    reg: float = 0.1,
     p: int = 2,
+    reg: float = 0.1,
+    num_step: int = 50,
     seed: int = 0,
-    num_sim: int = 2,
 ) -> float:
-    """Wasserstein distance from bicop obs to indep bicop simulations, by ot.sinkhorn2 (averaged for each observation).
+    """Wasserstein distance from bicop obs to indep bicop, by ot.sinkhorn2 (averaged for each observation).
 
     :param x: copula obs of shape (n,1)
     :type x: torch.Tensor
     :param y: copula obs of shape (n,1)
     :type y: torch.Tensor
+    :param p: p-norm to calculate distance between each vector pair, defaults to 2
+    :type p: int, optional
     :param reg: regularization strength, defaults to 0.1
     :type reg: float, optional
-    :param p: p-norm distance to calculate between each vector pair, defaults to 2
-    :type p: int, optional
-    :param seed: random seed for torch.manual_seed() in indep bicop simulations, defaults to 0
+    :param num_step: number of steps in the independent bivariate copula grid, defaults to 50
+    :type num_step: int, optional
+    :param seed: random seed for torch.manual_seed(), defaults to 0
     :type seed: int, optional
-    :return: Wasserstein distance from bicop obs to indep bicop simulations
+    :return: Wasserstein distance from bicop obs to indep bicop
     :rtype: float
     """
     from ot import sinkhorn2
 
     torch.manual_seed(seed=seed)
-    X_s = torch.hstack([x, y])
-    num_obs = x.shape[0]
-    a, b = (
-        torch.ones(size=(num_obs, 1), device=x.device, dtype=x.dtype) / num_obs,
-        torch.ones(size=(num_obs, 1), device=x.device, dtype=x.dtype) / num_obs,
-    )
-    return (
-        sum(
-            (
-                sinkhorn2(
-                    a=a,
-                    b=b,
-                    M=torch.cdist(X_s, torch.rand_like(X_s), p=p),
-                    reg=reg,
-                ).item()
-                for _ in range(num_sim)
-            )
-        )
-        / num_sim
-    )

+    return sinkhorn2(
+        a=torch.ones_like(x) / x.shape[0],
+        b=torch.ones(size=(num_step**2, 1), device=x.device, dtype=x.dtype) / num_step**2,
+        M=torch.cdist(
+            x1=torch.hstack([x, y]),
+            x2=torch.as_tensor(
+                (
+                    *product(
+                        torch.linspace(0, 1, num_step),
+                        torch.linspace(0, 1, num_step),
+                    ),
+                ),
+                device=x.device,
+                dtype=x.dtype,
+            ),
+            p=p,
+        ),
+        reg=reg,
+    ).item()
@@ -1040,7 +1042,7 @@

Source code for torchvinecopulib.util
-
+
diff --git a/docs/_build/html/_modules/torchvinecopulib/vinecop/_data_vcp.html b/docs/_build/html/_modules/torchvinecopulib/vinecop/_data_vcp.html index 5c67948..05cc6c5 100644 --- a/docs/_build/html/_modules/torchvinecopulib/vinecop/_data_vcp.html +++ b/docs/_build/html/_modules/torchvinecopulib/vinecop/_data_vcp.html @@ -5,7 +5,7 @@ - torchvinecopulib.vinecop._data_vcp - torchvinecopulib 2024.4.2 documentation + torchvinecopulib.vinecop._data_vcp - torchvinecopulib 2024.5.0 documentation @@ -124,7 +124,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -147,7 +147,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -538,6 +538,7 @@

Source code for torchvinecopulib.vinecop._data_vcp

self, tpl_first_vs: tuple = tuple(), tpl_sim: tuple = tuple(), + title: str = "Vine Copula, Obs and BiCop", font_size_vertex: int = 8, f_path: Path = None, fig_size: tuple = None, @@ -566,7 +567,7 @@

Source code for torchvinecopulib.vinecop._data_vcp

fig, ax = plt.subplots(nrows=1, ncols=1, figsize=fig_size) ax.set_title( - label="Vine Copula, Obs and BiCop", + label=title, fontsize=font_size_vertex + 1, ) G = nx.DiGraph() @@ -673,6 +674,7 @@

Source code for torchvinecopulib.vinecop._data_vcp

alpha=0.8, ) fig.tight_layout() + plt.box(False) plt.draw_if_interactive() if f_path: fig.savefig(fname=f_path, bbox_inches="tight") @@ -806,7 +808,7 @@

Source code for torchvinecopulib.vinecop._data_vcp

self, obs_mvcp: torch.Tensor, tpl_sim: tuple = tuple(), - ) -> torch.Tensor: + ) -> dict: """Rosenblatt transformation, from the multivariate copula (with dependence) to the uniform multivariate copula (independent), using constructed vine copula @@ -816,7 +818,7 @@

Source code for torchvinecopulib.vinecop._data_vcp

gives flexibility to experienced users, defaults to tuple() :type tpl_sim: tuple, optional :return: ideally independent uniform multivariate copula, of shape (num_obs, num_dim) - :rtype: torch.Tensor + :rtype: dict """ num_dim = self.num_dim if not tpl_sim: @@ -1079,7 +1081,7 @@

Source code for torchvinecopulib.vinecop._data_vcp

+
diff --git a/docs/_build/html/_modules/torchvinecopulib/vinecop/_factory_vcp.html b/docs/_build/html/_modules/torchvinecopulib/vinecop/_factory_vcp.html index e059287..ddea3ff 100644 --- a/docs/_build/html/_modules/torchvinecopulib/vinecop/_factory_vcp.html +++ b/docs/_build/html/_modules/torchvinecopulib/vinecop/_factory_vcp.html @@ -5,7 +5,7 @@ - torchvinecopulib.vinecop._factory_vcp - torchvinecopulib 2024.4.2 documentation + torchvinecopulib.vinecop._factory_vcp - torchvinecopulib 2024.5.0 documentation @@ -124,7 +124,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -147,7 +147,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -794,7 +794,7 @@

Source code for torchvinecopulib.vinecop._factory_vcp

+
diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js index 6080f44..da197c3 100644 --- a/docs/_build/html/_static/documentation_options.js +++ b/docs/_build/html/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '2024.4.2', + VERSION: '2024.5.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html index 770ba48..ceb96cc 100644 --- a/docs/_build/html/genindex.html +++ b/docs/_build/html/genindex.html @@ -4,7 +4,7 @@ - Index - torchvinecopulib 2024.4.2 documentation + Index - torchvinecopulib 2024.5.0 documentation @@ -123,7 +123,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -146,7 +146,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -742,7 +742,7 @@

W

-
+
diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html index cb0c78a..04f9453 100644 --- a/docs/_build/html/index.html +++ b/docs/_build/html/index.html @@ -6,7 +6,7 @@ - torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -125,7 +125,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -148,7 +148,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -263,7 +263,7 @@

Indices and tables +

diff --git a/docs/_build/html/modules.html b/docs/_build/html/modules.html index 48f6f69..0eab4a8 100644 --- a/docs/_build/html/modules.html +++ b/docs/_build/html/modules.html @@ -6,7 +6,7 @@ - torchvinecopulib - torchvinecopulib 2024.4.2 documentation + torchvinecopulib - torchvinecopulib 2024.5.0 documentation @@ -125,7 +125,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -148,7 +148,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -253,7 +253,7 @@

torchvinecopulib +

diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html index a6927df..4b0032c 100644 --- a/docs/_build/html/py-modindex.html +++ b/docs/_build/html/py-modindex.html @@ -4,7 +4,7 @@ - Python Module Index - torchvinecopulib 2024.4.2 documentation + Python Module Index - torchvinecopulib 2024.5.0 documentation @@ -123,7 +123,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -146,7 +146,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -262,7 +262,7 @@

Python Module Index

-
+
diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html index 034586b..b282287 100644 --- a/docs/_build/html/search.html +++ b/docs/_build/html/search.html @@ -7,7 +7,7 @@ -Search - torchvinecopulib 2024.4.2 documentation +Search - torchvinecopulib 2024.5.0 documentation @@ -125,7 +125,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -148,7 +148,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -237,7 +237,7 @@
-
+
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 109c42c..f92b70d 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"Contents": [[0, null]], "Indices and tables": [[0, "indices-and-tables"]], "Module contents": [[2, "module-torchvinecopulib"], [3, "module-torchvinecopulib.bicop"], [4, "module-torchvinecopulib.util"], [5, "module-torchvinecopulib.vinecop"]], "Subpackages": [[2, "subpackages"]], "Welcome to torchvinecopulib\u2019s documentation!": [[0, "welcome-to-torchvinecopulib-s-documentation"]], "torchvinecopulib": [[1, "torchvinecopulib"]], "torchvinecopulib package": [[2, "torchvinecopulib-package"]], "torchvinecopulib.bicop package": [[3, "torchvinecopulib-bicop-package"]], "torchvinecopulib.util package": [[4, "torchvinecopulib-util-package"]], "torchvinecopulib.vinecop package": [[5, "torchvinecopulib-vinecop-package"]]}, "docnames": ["index", "modules", "torchvinecopulib", "torchvinecopulib.bicop", "torchvinecopulib.util", "torchvinecopulib.vinecop"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["index.rst", "modules.rst", "torchvinecopulib.rst", "torchvinecopulib.bicop.rst", "torchvinecopulib.util.rst", "torchvinecopulib.vinecop.rst"], "indexentries": {"aic (torchvinecopulib.vinecop.datavinecop property)": [[5, "torchvinecopulib.vinecop.DataVineCop.aic", false]], "bic (torchvinecopulib.vinecop.datavinecop property)": [[5, "torchvinecopulib.vinecop.DataVineCop.bic", false]], "cdf() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.cdf", false]], "datavinecop (class in torchvinecopulib.vinecop)": [[5, "torchvinecopulib.vinecop.DataVineCop", false]], "dct_bcp (torchvinecopulib.vinecop.datavinecop attribute)": [[5, "torchvinecopulib.vinecop.DataVineCop.dct_bcp", false]], "dct_tree (torchvinecopulib.vinecop.datavinecop attribute)": [[5, "torchvinecopulib.vinecop.DataVineCop.dct_tree", false]], "draw_dag() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.draw_dag", false]], "draw_lv() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.draw_lv", false]], "l_pdf() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.l_pdf", false]], "matrix (torchvinecopulib.vinecop.datavinecop property)": [[5, "torchvinecopulib.vinecop.DataVineCop.matrix", false]], "module": [[2, "module-torchvinecopulib", false], [5, "module-torchvinecopulib.vinecop", false]], "mtd_bidep (torchvinecopulib.vinecop.datavinecop attribute)": [[5, "torchvinecopulib.vinecop.DataVineCop.mtd_bidep", false]], "negloglik (torchvinecopulib.vinecop.datavinecop property)": [[5, "torchvinecopulib.vinecop.DataVineCop.negloglik", false]], "num_dim (torchvinecopulib.vinecop.datavinecop property)": [[5, "torchvinecopulib.vinecop.DataVineCop.num_dim", false]], "num_obs (torchvinecopulib.vinecop.datavinecop property)": [[5, "torchvinecopulib.vinecop.DataVineCop.num_obs", false]], "num_par (torchvinecopulib.vinecop.datavinecop property)": [[5, "torchvinecopulib.vinecop.DataVineCop.num_par", false]], "rosenblatt_transform() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.rosenblatt_transform", false]], "sim() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.sim", false]], "torchvinecopulib": [[2, "module-torchvinecopulib", false]], "torchvinecopulib.vinecop": [[5, "module-torchvinecopulib.vinecop", false]], "tpl_sim (torchvinecopulib.vinecop.datavinecop attribute)": [[5, "torchvinecopulib.vinecop.DataVineCop.tpl_sim", false]], "vcp_from_json() (in module torchvinecopulib.vinecop)": [[5, "torchvinecopulib.vinecop.vcp_from_json", false]], "vcp_from_obs() (in module torchvinecopulib.vinecop)": [[5, "torchvinecopulib.vinecop.vcp_from_obs", false]], "vcp_from_pth() (in module torchvinecopulib.vinecop)": [[5, "torchvinecopulib.vinecop.vcp_from_pth", false]], "vcp_to_json() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.vcp_to_json", false]], "vcp_to_pth() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.vcp_to_pth", false]]}, "objects": {"": [[2, 0, 0, "-", "torchvinecopulib"]], "torchvinecopulib": [[3, 0, 0, "-", "bicop"], [4, 0, 0, "-", "util"], [5, 0, 0, "-", "vinecop"]], "torchvinecopulib.bicop": [[3, 1, 1, "", "Clayton"], [3, 1, 1, "", "DataBiCop"], [3, 1, 1, "", "ENUM_FAM_BICOP"], [3, 1, 1, "", "Frank"], [3, 1, 1, "", "Gaussian"], [3, 1, 1, "", "Gumbel"], [3, 1, 1, "", "Independent"], [3, 1, 1, "", "Joe"], [3, 1, 1, "", "StudentT"], [3, 5, 1, "", "bcp_from_obs"]], "torchvinecopulib.bicop.Clayton": [[3, 2, 1, "", "cdf_0"], [3, 2, 1, "", "hfunc1_0"], [3, 2, 1, "", "hinv1_0"], [3, 2, 1, "", "l_pdf_0"], [3, 2, 1, "", "par2tau_0"], [3, 2, 1, "", "tau2par_0"]], "torchvinecopulib.bicop.DataBiCop": [[3, 3, 1, "", "aic"], [3, 3, 1, "", "bic"], [3, 2, 1, "", "cdf"], [3, 4, 1, "", "fam"], [3, 2, 1, "", "hfunc1"], [3, 2, 1, "", "hfunc2"], [3, 2, 1, "", "hinv1"], [3, 2, 1, "", "hinv2"], [3, 2, 1, "", "l_pdf"], [3, 4, 1, "", "negloglik"], [3, 4, 1, "", "num_obs"], [3, 3, 1, "", "num_par"], [3, 4, 1, "", "par"], [3, 4, 1, "", "rot"], [3, 2, 1, "", "sim"], [3, 3, 1, "", "tau"]], "torchvinecopulib.bicop.ENUM_FAM_BICOP": [[3, 4, 1, "", "Clayton"], [3, 4, 1, "", "Frank"], [3, 4, 1, "", "Gaussian"], [3, 4, 1, "", "Gumbel"], [3, 4, 1, "", "Independent"], [3, 4, 1, "", "Joe"], [3, 4, 1, "", "StudentT"]], "torchvinecopulib.bicop.Frank": [[3, 2, 1, "", "cdf_0"], [3, 2, 1, "", "hfunc1_0"], [3, 2, 1, "", "hinv1_0"], [3, 2, 1, "", "l_pdf_0"], [3, 2, 1, "", "par2tau_0"], [3, 2, 1, "", "pdf_0"], [3, 2, 1, "", "tau2par"]], "torchvinecopulib.bicop.Gaussian": [[3, 2, 1, "", "cdf_0"], [3, 2, 1, "", "hfunc1_0"], [3, 2, 1, "", "hinv1_0"], [3, 2, 1, "", "l_pdf_0"], [3, 2, 1, "", "par2tau_0"], [3, 2, 1, "", "tau2par"]], "torchvinecopulib.bicop.Gumbel": [[3, 2, 1, "", "cdf_0"], [3, 2, 1, "", "hfunc1_0"], [3, 2, 1, "", "hinv1_0"], [3, 2, 1, "", "l_pdf_0"], [3, 2, 1, "", "par2tau_0"], [3, 2, 1, "", "pdf_0"], [3, 2, 1, "", "tau2par"]], "torchvinecopulib.bicop.Independent": [[3, 2, 1, "", "cdf_0"], [3, 2, 1, "", "hfunc1_0"], [3, 2, 1, "", "hinv1_0"], [3, 2, 1, "", "l_pdf_0"], [3, 2, 1, "", "par2tau_0"], [3, 2, 1, "", "pdf_0"], [3, 2, 1, "", "sim"], [3, 2, 1, "", "tau2par_0"]], "torchvinecopulib.bicop.Joe": [[3, 2, 1, "", "cdf_0"], [3, 2, 1, "", "hfunc1_0"], [3, 2, 1, "", "hinv1_0"], [3, 2, 1, "", "l_pdf_0"], [3, 2, 1, "", "par2tau_0"], [3, 2, 1, "", "pdf_0"], [3, 2, 1, "", "tau2par"]], "torchvinecopulib.bicop.StudentT": [[3, 2, 1, "", "cdf_0"], [3, 2, 1, "", "hfunc1_0"], [3, 2, 1, "", "hinv1_0"], [3, 2, 1, "", "l_pdf_0"], [3, 2, 1, "", "par2tau_0"], [3, 2, 1, "", "tau2par"]], "torchvinecopulib.util": [[4, 1, 1, "", "ENUM_FUNC_BIDEP"], [4, 5, 1, "", "cdf_func_kernel"], [4, 5, 1, "", "chatterjee_xi"], [4, 5, 1, "", "debye1"], [4, 5, 1, "", "ferreira_tail_dep_coeff"], [4, 5, 1, "", "kendall_tau"], [4, 5, 1, "", "mutual_info"], [4, 5, 1, "", "solve_ITP"], [4, 5, 1, "", "wasserstein_dist_ind"]], "torchvinecopulib.util.ENUM_FUNC_BIDEP": [[4, 4, 1, "", "chatterjee_xi"], [4, 4, 1, "", "ferreira_tail_dep_coeff"], [4, 4, 1, "", "kendall_tau"], [4, 4, 1, "", "mutual_info"], [4, 4, 1, "", "wasserstein_dist_ind"]], "torchvinecopulib.vinecop": [[5, 1, 1, "", "DataVineCop"], [5, 5, 1, "", "vcp_from_json"], [5, 5, 1, "", "vcp_from_obs"], [5, 5, 1, "", "vcp_from_pth"]], "torchvinecopulib.vinecop.DataVineCop": [[5, 3, 1, "", "aic"], [5, 3, 1, "", "bic"], [5, 2, 1, "", "cdf"], [5, 4, 1, "", "dct_bcp"], [5, 4, 1, "", "dct_tree"], [5, 2, 1, "", "draw_dag"], [5, 2, 1, "", "draw_lv"], [5, 2, 1, "", "l_pdf"], [5, 3, 1, "", "matrix"], [5, 4, 1, "", "mtd_bidep"], [5, 3, 1, "", "negloglik"], [5, 3, 1, "", "num_dim"], [5, 3, 1, "", "num_obs"], [5, 3, 1, "", "num_par"], [5, 2, 1, "", "rosenblatt_transform"], [5, 2, 1, "", "sim"], [5, 4, 1, "", "tpl_sim"], [5, 2, 1, "", "vcp_to_json"], [5, 2, 1, "", "vcp_to_pth"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:attribute", "5": "py:function"}, "terms": {"": [3, 4, 5], "0": [3, 4, 5], "05": [3, 5], "09": 4, "1": [3, 4, 5], "10000": 5, "105270": 4, "110": 4, "116": 4, "180": [3, 4], "1e": 4, "2": [3, 4, 5], "2009": 4, "201": 4, "2013": [4, 5], "2020": 4, "2021": 4, "2022": 4, "2023": 4, "2024": 4, "24": 4, "270": [3, 4], "283": 4, "299": 4, "31": 4, "47": 4, "52": 5, "536": 4, "59": 5, "69": 5, "7": 5, "8": [4, 5], "90": [3, 4], "999": 4, "A": 4, "It": 4, "On": 4, "The": [3, 4, 5], "To": 4, "_clayton": 3, "_description_": 5, "_frank": 3, "_gaussian": 3, "_gumbel": 3, "_independ": 3, "_joe": 3, "_studentt": 3, "abc": [3, 5], "accur": 3, "acm": 4, "acycl": 5, "affect": 5, "aic": [2, 3, 5], "akaik": [3, 5], "all": 5, "alreadi": 5, "american": 4, "an": [3, 4, 5], "analysi": [4, 5], "applic": 5, "ar": [4, 5], "arbitrari": 4, "arrai": 5, "arrang": 5, "associ": 4, "assum": 4, "averag": 4, "avoid": [3, 4], "ax": 5, "b": [3, 4, 5], "b5797d7e4a71c71faf86df51f26ad0d8d551ad08": 4, "bandwidth": 4, "base": [3, 4, 5], "bayesian": [3, 5], "bcp_from_ob": [2, 3], "becaus": 4, "been": 4, "begin": 5, "below": [3, 5], "best": [3, 5], "between": 4, "bfg": [3, 5], "bic": [2, 3, 5], "bicop": [0, 1, 2, 4, 5], "bicopabstract": 3, "bicoparchimedean": 3, "bicopdata": 3, "bicopellipt": 3, "bidep": 5, "biometrika": 4, "bisect": 4, "bivari": [3, 4, 5], "blob": 4, "bool": [4, 5], "boost": 4, "both": 4, "brechmann": 5, "c": 5, "calcul": [3, 4, 5], "call": 5, "callabl": 4, "can": [3, 4, 5], "candid": [3, 5], "carlo": 5, "case": 4, "cdf": [2, 3, 4, 5], "cdf_0": [2, 3], "cdf_func_kernel": [2, 4], "chanc": 4, "character": 4, "chatterje": 4, "chatterjee_xi": [2, 4, 5], "class": [3, 4, 5], "classmethod": 3, "clayton": [2, 3, 5], "clockwis": 3, "cobyla": [3, 5], "coeffici": 4, "color": 5, "com": 4, "common": 4, "compon": 4, "comput": [4, 5], "cond": 5, "cond_set": 5, "condit": 5, "confirm": 4, "consist": 4, "construct": 5, "content": 1, "control": 4, "convert": 3, "copula": [3, 4, 5], "correl": 4, "correspond": [3, 5], "could": [3, 5], "counter": 3, "cpu": [3, 5], "criterion": [3, 5], "cross": 4, "cumul": [3, 4, 5], "curv": 4, "cvine": 5, "cxx": 4, "czado": 5, "d": 5, "dag": 5, "data": [3, 4, 5], "databicop": [2, 3, 5], "dataclass": [3, 5], "datavinecop": [2, 5], "dct_bcp": [2, 5], "dct_first_v": 5, "dct_tree": [2, 5], "deby": 4, "debye1": [2, 4], "deeper": 5, "default": [3, 4, 5], "degre": 3, "densiti": [3, 4, 5], "depend": [4, 5], "devic": [3, 5], "dict": 5, "digit": 5, "dimens": 5, "direct": 5, "dissmann": 5, "distanc": 4, "distribut": [3, 4, 5], "do": 4, "doc": 4, "doe": 4, "draw": 5, "draw_dag": [2, 5], "draw_lv": [2, 5], "dtype": [3, 5], "dure": 3, "dvine": 5, "e": 5, "each": [4, 5], "edg": 5, "either": [3, 5], "empir": 4, "empti": 5, "en": 4, "encourag": 4, "engag": 4, "enhanc": 4, "enum": [3, 4], "enum_fam_bicop": [2, 3], "enum_func_bidep": [2, 4], "eps_2": 4, "epsilon": 4, "estim": [3, 4, 5], "expens": 4, "experienc": 5, "explicitli": 5, "exponenti": 4, "f": 4, "f2b38b898f6eab0d87ec248ea39fde94": [], "f_path": 5, "factori": 3, "fals": 5, "fam": [2, 3], "famili": [3, 5], "fast": 4, "fastmi": 4, "feature_select": 4, "ferreira": 4, "ferreira_tail_dep_coeff": [2, 4, 5], "fig": 5, "fig_siz": 5, "figur": 5, "file": 5, "financi": 5, "first": [3, 5], "fit": [3, 4, 5], "flexibl": 5, "float": [3, 4, 5], "float64": [3, 5], "fn": 4, "follow": 5, "font": 5, "font_size_edg": 5, "font_size_vertex": 5, "frank": [2, 3, 5], "from": [3, 4, 5], "frozenset_cond": 5, "full": 5, "func": 4, "function": [3, 4, 5], "functool": 4, "further": [3, 5], "gaussian": [2, 3, 5], "gener": 4, "gist": [], "github": 4, "give": [4, 5], "given": [3, 5], "good": 4, "graph": 5, "guarante": 4, "gumbel": [2, 3, 5], "h": [3, 4], "ha": [4, 5], "han": 4, "harder": 4, "hardwir": 4, "hfunc": 5, "hfunc1": [2, 3], "hfunc1_0": [2, 3], "hfunc2": [2, 3], "highlight": 5, "hinv": 5, "hinv1": [2, 3], "hinv1_0": [2, 3], "hinv2": [2, 3], "howev": 4, "html": 4, "http": 4, "i": [3, 4, 5], "ideal": 5, "ignor": [3, 5], "iid": 4, "ili3p": [], "impact": 4, "implement": 4, "indep": 4, "independ": [2, 3, 5], "index": 0, "inform": [3, 4, 5], "insid": 4, "instanc": [3, 5], "instanti": 3, "int": [3, 4, 5], "integr": 4, "interest": 4, "interpret": 4, "invers": [3, 5], "is_bcp": 5, "is_dissmann": 5, "is_scott": 4, "is_sklearn": 4, "itau": [3, 5], "iter": 4, "itp": 4, "itp_method": 4, "j": 5, "j_max": 4, "joe": [2, 3, 5], "journal": 4, "json": 5, "k": 4, "k1": 4, "k2": 4, "k_1": 4, "k_2": 4, "kde": 4, "kendal": [3, 5], "kendall_tau": [2, 4, 5], "kept": 5, "kernel": 4, "kurbo": 4, "kurowicka": 5, "kwarg": 3, "l": [3, 5], "l_pdf": [2, 3, 5], "l_pdf_0": [2, 3], "label": 5, "larg": 4, "learn": 4, "left": 5, "length": 3, "level": 5, "lib": 4, "like": 4, "likelihood": [3, 5], "limit": 4, "lin": 4, "load": 5, "log": [3, 5], "lower": 4, "lv": 5, "m": 4, "mai": [4, 5], "major": 5, "make": 3, "manual_se": [3, 4, 5], "match": 4, "mathemat": 4, "matrix": [2, 5], "max": 4, "maximum": [3, 5], "measur": [4, 5], "method": [3, 4, 5], "minim": [3, 5], "minimum": 5, "minmax": 4, "mle": [3, 5], "model": [3, 5], "modifi": 3, "modul": [0, 1], "monoton": 4, "mont": 5, "more": 4, "mst": 5, "mtd_bidep": [2, 5], "mtd_fit": [3, 5], "mtd_mle": [3, 5], "mtd_opt": 3, "mtd_sel": [3, 5], "mtd_vine": 5, "multivari": [4, 5], "mutual": 4, "mutual_info": [2, 4, 5], "mutual_info_regress": 4, "n": [4, 5], "n0": 4, "n_0": 4, "name": [3, 5], "nan": 3, "ndarrai": 5, "nearest": 4, "necessari": 5, "neg": [3, 4, 5], "negloglik": [2, 3, 5], "neighbor": 4, "neither": 3, "new": 4, "nll": 5, "node": 5, "none": [3, 5], "nonparametr": 4, "nor": 3, "norm": 4, "notimplementederror": 3, "np": 5, "num": 4, "num_digit": 5, "num_dim": [2, 5], "num_ob": [2, 3, 5], "num_par": [2, 3, 5], "num_sim": [3, 4, 5], "number": [3, 4, 5], "ob": [3, 4, 5], "object": [3, 5], "obs_bcp": 3, "obs_mvcp": 5, "observ": [3, 4, 5], "occur": 4, "oliveira": 4, "one": [3, 4, 5], "onli": 4, "openturn": 4, "optim": [3, 4, 5], "option": [3, 4, 5], "order": [4, 5], "org": 4, "ot": 4, "other": 5, "otherwis": 4, "p": [3, 4], "packag": [0, 1], "page": 0, "pair": 4, "pairwis": 4, "paper": 4, "par": [2, 3], "par2tau_0": [2, 3], "param": [], "paramet": [3, 4, 5], "partial": 4, "path": 5, "pdf": [3, 5], "pdf_0": [2, 3], "per": 5, "perform": 4, "pickl": [], "pkl": [], "point": 4, "possibl": 4, "power": 4, "pp": 4, "prescrib": 5, "preserv": 4, "prev": 5, "priorit": 5, "prioriti": 5, "prob": 3, "probabl": [3, 5], "problem": 4, "properti": [3, 5], "pseudo": 5, "pth": 5, "purkayastha": 4, "q": 3, "quantil": 5, "r": 4, "rais": [3, 5], "rand": [3, 5], "random": [3, 4, 5], "rank": 4, "reach": 5, "read": 5, "record": 3, "recurs": 5, "refer": 4, "reg": 4, "regress": 5, "regular": [4, 5], "reject": [3, 5], "rel": 4, "requir": 4, "resembl": 4, "result": 4, "return": [3, 4, 5], "revis": 4, "right": [4, 5], "rosenblatt": 5, "rosenblatt_transform": [2, 5], "rot": [2, 3], "rotat": [3, 4], "round": 5, "row": 5, "rtype": [], "rule": 4, "rvine": 5, "sampl": 4, "save": 5, "scikit": 4, "scipi": [3, 5], "scott": 4, "search": 0, "secant": 4, "second": 3, "seed": [3, 4, 5], "select": [3, 5], "self": [3, 5], "sequenti": 5, "set": 5, "set_cond": 5, "shallow": 5, "shape": [3, 4, 5], "sim": [2, 3, 5], "simul": [3, 4, 5], "sinkhorn2": 4, "size": 5, "sklearn": 4, "smooth": 4, "so": 4, "softwar": 4, "solv": 4, "solve_itp": [2, 4], "some": 5, "song": 4, "sourc": [3, 4, 5], "span": 5, "specfunc": 4, "src": 4, "stabl": 4, "static": 3, "statist": [4, 5], "store": [3, 5], "str": [3, 5], "strength": 4, "strictli": 4, "structur": 5, "studentt": [2, 3, 5], "subpackag": 1, "subset": [3, 5], "suggest": 4, "sum": 5, "superior": 4, "symmetr": [3, 4], "tail": 4, "takahashi": 4, "taken": [3, 4, 5], "tau": [2, 3, 5], "tau2par": [2, 3], "tau2par_0": [2, 3], "tau_max": 4, "tau_min": 4, "tensor": [3, 4, 5], "test": [3, 4, 5], "than": 4, "thi": 4, "though": 4, "thresh_trunc": [3, 5], "threshold": [3, 5], "thu": 4, "tom": 4, "top": 5, "topk": [3, 5], "torch": [3, 4, 5], "tpl_fam": [3, 5], "tpl_first": 5, "tpl_first_v": 5, "tpl_sim": [2, 5], "transact": 4, "transform": 5, "tree": 5, "triangular": 5, "true": [4, 5], "tune": 4, "tupl": [3, 5], "type": [3, 4, 5], "unexpect": 4, "uniform": 5, "until": 5, "upper": [4, 5], "upward": 5, "us": [3, 4, 5], "user": [4, 5], "util": [0, 1, 2], "v0": 3, "v1": 3, "v2": 3, "v_left": 3, "v_right": 3, "valu": [3, 4], "valueerror": 5, "vcp": 5, "vcp_from_json": [2, 5], "vcp_from_ob": [2, 5], "vcp_from_pkl": [], "vcp_from_pth": [2, 5], "vcp_to_json": [2, 5], "vcp_to_pkl": [], "vcp_to_pth": [2, 5], "vector": 4, "vertex": 5, "vertex_left": 5, "vertex_right": 5, "vertic": 5, "vine": 5, "vinecop": [0, 1, 2], "walk": 5, "wasserstein": 4, "wasserstein_dist_ind": [2, 4, 5], "we": [3, 5], "weight": 5, "well": 4, "when": [3, 4, 5], "where": 5, "whether": [4, 5], "which": [3, 5], "whose": 5, "wiki": 4, "wikipedia": 4, "windowspath": 5, "within": 4, "work": 4, "workflow": 5, "worst": 4, "x": 4, "y": 4, "yellow": 5, "z": 4, "zero": 4, "\u03bb": 4, "\u03be": 4}, "titles": ["Welcome to torchvinecopulib\u2019s documentation!", "torchvinecopulib", "torchvinecopulib package", "torchvinecopulib.bicop package", "torchvinecopulib.util package", "torchvinecopulib.vinecop package"], "titleterms": {"": 0, "bicop": 3, "content": [0, 2, 3, 4, 5], "document": 0, "indic": 0, "modul": [2, 3, 4, 5], "packag": [2, 3, 4, 5], "subpackag": 2, "tabl": 0, "torchvinecopulib": [0, 1, 2, 3, 4, 5], "util": 4, "vinecop": 5, "welcom": 0}}) \ No newline at end of file +Search.setIndex({"alltitles": {"Contents": [[0, null]], "Indices and tables": [[0, "indices-and-tables"]], "Module contents": [[2, "module-torchvinecopulib"], [3, "module-torchvinecopulib.bicop"], [4, "module-torchvinecopulib.util"], [5, "module-torchvinecopulib.vinecop"]], "Subpackages": [[2, "subpackages"]], "Welcome to torchvinecopulib\u2019s documentation!": [[0, "welcome-to-torchvinecopulib-s-documentation"]], "torchvinecopulib": [[1, "torchvinecopulib"]], "torchvinecopulib package": [[2, "torchvinecopulib-package"]], "torchvinecopulib.bicop package": [[3, "torchvinecopulib-bicop-package"]], "torchvinecopulib.util package": [[4, "torchvinecopulib-util-package"]], "torchvinecopulib.vinecop package": [[5, "torchvinecopulib-vinecop-package"]]}, "docnames": ["index", "modules", "torchvinecopulib", "torchvinecopulib.bicop", "torchvinecopulib.util", "torchvinecopulib.vinecop"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["index.rst", "modules.rst", "torchvinecopulib.rst", "torchvinecopulib.bicop.rst", "torchvinecopulib.util.rst", "torchvinecopulib.vinecop.rst"], "indexentries": {"aic (torchvinecopulib.bicop.databicop property)": [[3, "torchvinecopulib.bicop.DataBiCop.aic", false]], "aic (torchvinecopulib.vinecop.datavinecop property)": [[5, "torchvinecopulib.vinecop.DataVineCop.aic", false]], "bcp_from_obs() (in module torchvinecopulib.bicop)": [[3, "torchvinecopulib.bicop.bcp_from_obs", false]], "bic (torchvinecopulib.bicop.databicop property)": [[3, "torchvinecopulib.bicop.DataBiCop.bic", false]], "bic (torchvinecopulib.vinecop.datavinecop property)": [[5, "torchvinecopulib.vinecop.DataVineCop.bic", false]], "cdf() (torchvinecopulib.bicop.databicop method)": [[3, "torchvinecopulib.bicop.DataBiCop.cdf", false]], "cdf() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.cdf", false]], "cdf_0() (torchvinecopulib.bicop.clayton static method)": [[3, "torchvinecopulib.bicop.Clayton.cdf_0", false]], "cdf_0() (torchvinecopulib.bicop.frank static method)": [[3, "torchvinecopulib.bicop.Frank.cdf_0", false]], "cdf_0() (torchvinecopulib.bicop.gaussian static method)": [[3, "torchvinecopulib.bicop.Gaussian.cdf_0", false]], "cdf_0() (torchvinecopulib.bicop.gumbel static method)": [[3, "torchvinecopulib.bicop.Gumbel.cdf_0", false]], "cdf_0() (torchvinecopulib.bicop.independent static method)": [[3, "torchvinecopulib.bicop.Independent.cdf_0", false]], "cdf_0() (torchvinecopulib.bicop.joe static method)": [[3, "torchvinecopulib.bicop.Joe.cdf_0", false]], "cdf_0() (torchvinecopulib.bicop.studentt static method)": [[3, "torchvinecopulib.bicop.StudentT.cdf_0", false]], "clayton (class in torchvinecopulib.bicop)": [[3, "torchvinecopulib.bicop.Clayton", false]], "clayton (torchvinecopulib.bicop.enum_fam_bicop attribute)": [[3, "torchvinecopulib.bicop.ENUM_FAM_BICOP.Clayton", false]], "databicop (class in torchvinecopulib.bicop)": [[3, "torchvinecopulib.bicop.DataBiCop", false]], "datavinecop (class in torchvinecopulib.vinecop)": [[5, "torchvinecopulib.vinecop.DataVineCop", false]], "dct_bcp (torchvinecopulib.vinecop.datavinecop attribute)": [[5, "torchvinecopulib.vinecop.DataVineCop.dct_bcp", false]], "dct_tree (torchvinecopulib.vinecop.datavinecop attribute)": [[5, "torchvinecopulib.vinecop.DataVineCop.dct_tree", false]], "draw_dag() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.draw_dag", false]], "draw_lv() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.draw_lv", false]], "enum_fam_bicop (class in torchvinecopulib.bicop)": [[3, "torchvinecopulib.bicop.ENUM_FAM_BICOP", false]], "fam (torchvinecopulib.bicop.databicop attribute)": [[3, "torchvinecopulib.bicop.DataBiCop.fam", false]], "frank (class in torchvinecopulib.bicop)": [[3, "torchvinecopulib.bicop.Frank", false]], "frank (torchvinecopulib.bicop.enum_fam_bicop attribute)": [[3, "torchvinecopulib.bicop.ENUM_FAM_BICOP.Frank", false]], "gaussian (class in torchvinecopulib.bicop)": [[3, "torchvinecopulib.bicop.Gaussian", false]], "gaussian (torchvinecopulib.bicop.enum_fam_bicop attribute)": [[3, "torchvinecopulib.bicop.ENUM_FAM_BICOP.Gaussian", false]], "gumbel (class in torchvinecopulib.bicop)": [[3, "torchvinecopulib.bicop.Gumbel", false]], "gumbel (torchvinecopulib.bicop.enum_fam_bicop attribute)": [[3, "torchvinecopulib.bicop.ENUM_FAM_BICOP.Gumbel", false]], "hfunc1() (torchvinecopulib.bicop.databicop method)": [[3, "torchvinecopulib.bicop.DataBiCop.hfunc1", false]], "hfunc1_0() (torchvinecopulib.bicop.clayton static method)": [[3, "torchvinecopulib.bicop.Clayton.hfunc1_0", false]], "hfunc1_0() (torchvinecopulib.bicop.frank static method)": [[3, "torchvinecopulib.bicop.Frank.hfunc1_0", false]], "hfunc1_0() (torchvinecopulib.bicop.gaussian static method)": [[3, "torchvinecopulib.bicop.Gaussian.hfunc1_0", false]], "hfunc1_0() (torchvinecopulib.bicop.gumbel static method)": [[3, "torchvinecopulib.bicop.Gumbel.hfunc1_0", false]], "hfunc1_0() (torchvinecopulib.bicop.independent static method)": [[3, "torchvinecopulib.bicop.Independent.hfunc1_0", false]], "hfunc1_0() (torchvinecopulib.bicop.joe static method)": [[3, "torchvinecopulib.bicop.Joe.hfunc1_0", false]], "hfunc1_0() (torchvinecopulib.bicop.studentt static method)": [[3, "torchvinecopulib.bicop.StudentT.hfunc1_0", false]], "hfunc2() (torchvinecopulib.bicop.databicop method)": [[3, "torchvinecopulib.bicop.DataBiCop.hfunc2", false]], "hinv1() (torchvinecopulib.bicop.databicop method)": [[3, "torchvinecopulib.bicop.DataBiCop.hinv1", false]], "hinv1_0() (torchvinecopulib.bicop.clayton static method)": [[3, "torchvinecopulib.bicop.Clayton.hinv1_0", false]], "hinv1_0() (torchvinecopulib.bicop.frank static method)": [[3, "torchvinecopulib.bicop.Frank.hinv1_0", false]], "hinv1_0() (torchvinecopulib.bicop.gaussian static method)": [[3, "torchvinecopulib.bicop.Gaussian.hinv1_0", false]], "hinv1_0() (torchvinecopulib.bicop.gumbel static method)": [[3, "torchvinecopulib.bicop.Gumbel.hinv1_0", false]], "hinv1_0() (torchvinecopulib.bicop.independent static method)": [[3, "torchvinecopulib.bicop.Independent.hinv1_0", false]], "hinv1_0() (torchvinecopulib.bicop.joe static method)": [[3, "torchvinecopulib.bicop.Joe.hinv1_0", false]], "hinv1_0() (torchvinecopulib.bicop.studentt static method)": [[3, "torchvinecopulib.bicop.StudentT.hinv1_0", false]], "hinv2() (torchvinecopulib.bicop.databicop method)": [[3, "torchvinecopulib.bicop.DataBiCop.hinv2", false]], "independent (class in torchvinecopulib.bicop)": [[3, "torchvinecopulib.bicop.Independent", false]], "independent (torchvinecopulib.bicop.enum_fam_bicop attribute)": [[3, "torchvinecopulib.bicop.ENUM_FAM_BICOP.Independent", false]], "joe (class in torchvinecopulib.bicop)": [[3, "torchvinecopulib.bicop.Joe", false]], "joe (torchvinecopulib.bicop.enum_fam_bicop attribute)": [[3, "torchvinecopulib.bicop.ENUM_FAM_BICOP.Joe", false]], "l_pdf() (torchvinecopulib.bicop.databicop method)": [[3, "torchvinecopulib.bicop.DataBiCop.l_pdf", false]], "l_pdf() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.l_pdf", false]], "l_pdf_0() (torchvinecopulib.bicop.clayton static method)": [[3, "torchvinecopulib.bicop.Clayton.l_pdf_0", false]], "l_pdf_0() (torchvinecopulib.bicop.frank class method)": [[3, "torchvinecopulib.bicop.Frank.l_pdf_0", false]], "l_pdf_0() (torchvinecopulib.bicop.gaussian static method)": [[3, "torchvinecopulib.bicop.Gaussian.l_pdf_0", false]], "l_pdf_0() (torchvinecopulib.bicop.gumbel class method)": [[3, "torchvinecopulib.bicop.Gumbel.l_pdf_0", false]], "l_pdf_0() (torchvinecopulib.bicop.independent static method)": [[3, "torchvinecopulib.bicop.Independent.l_pdf_0", false]], "l_pdf_0() (torchvinecopulib.bicop.joe class method)": [[3, "torchvinecopulib.bicop.Joe.l_pdf_0", false]], "l_pdf_0() (torchvinecopulib.bicop.studentt static method)": [[3, "torchvinecopulib.bicop.StudentT.l_pdf_0", false]], "matrix (torchvinecopulib.vinecop.datavinecop property)": [[5, "torchvinecopulib.vinecop.DataVineCop.matrix", false]], "module": [[2, "module-torchvinecopulib", false], [3, "module-torchvinecopulib.bicop", false], [5, "module-torchvinecopulib.vinecop", false]], "mtd_bidep (torchvinecopulib.vinecop.datavinecop attribute)": [[5, "torchvinecopulib.vinecop.DataVineCop.mtd_bidep", false]], "negloglik (torchvinecopulib.bicop.databicop attribute)": [[3, "torchvinecopulib.bicop.DataBiCop.negloglik", false]], "negloglik (torchvinecopulib.vinecop.datavinecop property)": [[5, "torchvinecopulib.vinecop.DataVineCop.negloglik", false]], "num_dim (torchvinecopulib.vinecop.datavinecop property)": [[5, "torchvinecopulib.vinecop.DataVineCop.num_dim", false]], "num_obs (torchvinecopulib.bicop.databicop attribute)": [[3, "torchvinecopulib.bicop.DataBiCop.num_obs", false]], "num_obs (torchvinecopulib.vinecop.datavinecop property)": [[5, "torchvinecopulib.vinecop.DataVineCop.num_obs", false]], "num_par (torchvinecopulib.bicop.databicop property)": [[3, "torchvinecopulib.bicop.DataBiCop.num_par", false]], "num_par (torchvinecopulib.vinecop.datavinecop property)": [[5, "torchvinecopulib.vinecop.DataVineCop.num_par", false]], "par (torchvinecopulib.bicop.databicop attribute)": [[3, "torchvinecopulib.bicop.DataBiCop.par", false]], "par2tau_0() (torchvinecopulib.bicop.clayton static method)": [[3, "torchvinecopulib.bicop.Clayton.par2tau_0", false]], "par2tau_0() (torchvinecopulib.bicop.frank static method)": [[3, "torchvinecopulib.bicop.Frank.par2tau_0", false]], "par2tau_0() (torchvinecopulib.bicop.gaussian class method)": [[3, "torchvinecopulib.bicop.Gaussian.par2tau_0", false]], "par2tau_0() (torchvinecopulib.bicop.gumbel static method)": [[3, "torchvinecopulib.bicop.Gumbel.par2tau_0", false]], "par2tau_0() (torchvinecopulib.bicop.independent static method)": [[3, "torchvinecopulib.bicop.Independent.par2tau_0", false]], "par2tau_0() (torchvinecopulib.bicop.joe static method)": [[3, "torchvinecopulib.bicop.Joe.par2tau_0", false]], "par2tau_0() (torchvinecopulib.bicop.studentt class method)": [[3, "torchvinecopulib.bicop.StudentT.par2tau_0", false]], "pdf_0() (torchvinecopulib.bicop.frank static method)": [[3, "torchvinecopulib.bicop.Frank.pdf_0", false]], "pdf_0() (torchvinecopulib.bicop.gumbel static method)": [[3, "torchvinecopulib.bicop.Gumbel.pdf_0", false]], "pdf_0() (torchvinecopulib.bicop.independent static method)": [[3, "torchvinecopulib.bicop.Independent.pdf_0", false]], "pdf_0() (torchvinecopulib.bicop.joe static method)": [[3, "torchvinecopulib.bicop.Joe.pdf_0", false]], "rosenblatt_transform() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.rosenblatt_transform", false]], "rot (torchvinecopulib.bicop.databicop attribute)": [[3, "torchvinecopulib.bicop.DataBiCop.rot", false]], "sim() (torchvinecopulib.bicop.databicop method)": [[3, "torchvinecopulib.bicop.DataBiCop.sim", false]], "sim() (torchvinecopulib.bicop.independent static method)": [[3, "torchvinecopulib.bicop.Independent.sim", false]], "sim() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.sim", false]], "studentt (class in torchvinecopulib.bicop)": [[3, "torchvinecopulib.bicop.StudentT", false]], "studentt (torchvinecopulib.bicop.enum_fam_bicop attribute)": [[3, "torchvinecopulib.bicop.ENUM_FAM_BICOP.StudentT", false]], "tau (torchvinecopulib.bicop.databicop property)": [[3, "torchvinecopulib.bicop.DataBiCop.tau", false]], "tau2par() (torchvinecopulib.bicop.frank static method)": [[3, "torchvinecopulib.bicop.Frank.tau2par", false]], "tau2par() (torchvinecopulib.bicop.gaussian class method)": [[3, "torchvinecopulib.bicop.Gaussian.tau2par", false]], "tau2par() (torchvinecopulib.bicop.gumbel static method)": [[3, "torchvinecopulib.bicop.Gumbel.tau2par", false]], "tau2par() (torchvinecopulib.bicop.joe static method)": [[3, "torchvinecopulib.bicop.Joe.tau2par", false]], "tau2par() (torchvinecopulib.bicop.studentt class method)": [[3, "torchvinecopulib.bicop.StudentT.tau2par", false]], "tau2par_0() (torchvinecopulib.bicop.clayton static method)": [[3, "torchvinecopulib.bicop.Clayton.tau2par_0", false]], "tau2par_0() (torchvinecopulib.bicop.independent static method)": [[3, "torchvinecopulib.bicop.Independent.tau2par_0", false]], "torchvinecopulib": [[2, "module-torchvinecopulib", false]], "torchvinecopulib.bicop": [[3, "module-torchvinecopulib.bicop", false]], "torchvinecopulib.vinecop": [[5, "module-torchvinecopulib.vinecop", false]], "tpl_sim (torchvinecopulib.vinecop.datavinecop attribute)": [[5, "torchvinecopulib.vinecop.DataVineCop.tpl_sim", false]], "vcp_from_json() (in module torchvinecopulib.vinecop)": [[5, "torchvinecopulib.vinecop.vcp_from_json", false]], "vcp_from_obs() (in module torchvinecopulib.vinecop)": [[5, "torchvinecopulib.vinecop.vcp_from_obs", false]], "vcp_from_pth() (in module torchvinecopulib.vinecop)": [[5, "torchvinecopulib.vinecop.vcp_from_pth", false]], "vcp_to_json() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.vcp_to_json", false]], "vcp_to_pth() (torchvinecopulib.vinecop.datavinecop method)": [[5, "torchvinecopulib.vinecop.DataVineCop.vcp_to_pth", false]]}, "objects": {"": [[2, 0, 0, "-", "torchvinecopulib"]], "torchvinecopulib": [[3, 0, 0, "-", "bicop"], [4, 0, 0, "-", "util"], [5, 0, 0, "-", "vinecop"]], "torchvinecopulib.bicop": [[3, 1, 1, "", "Clayton"], [3, 1, 1, "", "DataBiCop"], [3, 1, 1, "", "ENUM_FAM_BICOP"], [3, 1, 1, "", "Frank"], [3, 1, 1, "", "Gaussian"], [3, 1, 1, "", "Gumbel"], [3, 1, 1, "", "Independent"], [3, 1, 1, "", "Joe"], [3, 1, 1, "", "StudentT"], [3, 5, 1, "", "bcp_from_obs"]], "torchvinecopulib.bicop.Clayton": [[3, 2, 1, "", "cdf_0"], [3, 2, 1, "", "hfunc1_0"], [3, 2, 1, "", "hinv1_0"], [3, 2, 1, "", "l_pdf_0"], [3, 2, 1, "", "par2tau_0"], [3, 2, 1, "", "tau2par_0"]], "torchvinecopulib.bicop.DataBiCop": [[3, 3, 1, "", "aic"], [3, 3, 1, "", "bic"], [3, 2, 1, "", "cdf"], [3, 4, 1, "", "fam"], [3, 2, 1, "", "hfunc1"], [3, 2, 1, "", "hfunc2"], [3, 2, 1, "", "hinv1"], [3, 2, 1, "", "hinv2"], [3, 2, 1, "", "l_pdf"], [3, 4, 1, "", "negloglik"], [3, 4, 1, "", "num_obs"], [3, 3, 1, "", "num_par"], [3, 4, 1, "", "par"], [3, 4, 1, "", "rot"], [3, 2, 1, "", "sim"], [3, 3, 1, "", "tau"]], "torchvinecopulib.bicop.ENUM_FAM_BICOP": [[3, 4, 1, "", "Clayton"], [3, 4, 1, "", "Frank"], [3, 4, 1, "", "Gaussian"], [3, 4, 1, "", "Gumbel"], [3, 4, 1, "", "Independent"], [3, 4, 1, "", "Joe"], [3, 4, 1, "", "StudentT"]], "torchvinecopulib.bicop.Frank": [[3, 2, 1, "", "cdf_0"], [3, 2, 1, "", "hfunc1_0"], [3, 2, 1, "", "hinv1_0"], [3, 2, 1, "", "l_pdf_0"], [3, 2, 1, "", "par2tau_0"], [3, 2, 1, "", "pdf_0"], [3, 2, 1, "", "tau2par"]], "torchvinecopulib.bicop.Gaussian": [[3, 2, 1, "", "cdf_0"], [3, 2, 1, "", "hfunc1_0"], [3, 2, 1, "", "hinv1_0"], [3, 2, 1, "", "l_pdf_0"], [3, 2, 1, "", "par2tau_0"], [3, 2, 1, "", "tau2par"]], "torchvinecopulib.bicop.Gumbel": [[3, 2, 1, "", "cdf_0"], [3, 2, 1, "", "hfunc1_0"], [3, 2, 1, "", "hinv1_0"], [3, 2, 1, "", "l_pdf_0"], [3, 2, 1, "", "par2tau_0"], [3, 2, 1, "", "pdf_0"], [3, 2, 1, "", "tau2par"]], "torchvinecopulib.bicop.Independent": [[3, 2, 1, "", "cdf_0"], [3, 2, 1, "", "hfunc1_0"], [3, 2, 1, "", "hinv1_0"], [3, 2, 1, "", "l_pdf_0"], [3, 2, 1, "", "par2tau_0"], [3, 2, 1, "", "pdf_0"], [3, 2, 1, "", "sim"], [3, 2, 1, "", "tau2par_0"]], "torchvinecopulib.bicop.Joe": [[3, 2, 1, "", "cdf_0"], [3, 2, 1, "", "hfunc1_0"], [3, 2, 1, "", "hinv1_0"], [3, 2, 1, "", "l_pdf_0"], [3, 2, 1, "", "par2tau_0"], [3, 2, 1, "", "pdf_0"], [3, 2, 1, "", "tau2par"]], "torchvinecopulib.bicop.StudentT": [[3, 2, 1, "", "cdf_0"], [3, 2, 1, "", "hfunc1_0"], [3, 2, 1, "", "hinv1_0"], [3, 2, 1, "", "l_pdf_0"], [3, 2, 1, "", "par2tau_0"], [3, 2, 1, "", "tau2par"]], "torchvinecopulib.util": [[4, 1, 1, "", "ENUM_FUNC_BIDEP"], [4, 5, 1, "", "cdf_func_kernel"], [4, 5, 1, "", "chatterjee_xi"], [4, 5, 1, "", "debye1"], [4, 5, 1, "", "ferreira_tail_dep_coeff"], [4, 5, 1, "", "kendall_tau"], [4, 5, 1, "", "mutual_info"], [4, 5, 1, "", "solve_ITP"], [4, 5, 1, "", "wasserstein_dist_ind"]], "torchvinecopulib.util.ENUM_FUNC_BIDEP": [[4, 4, 1, "", "chatterjee_xi"], [4, 4, 1, "", "ferreira_tail_dep_coeff"], [4, 4, 1, "", "kendall_tau"], [4, 4, 1, "", "mutual_info"], [4, 4, 1, "", "wasserstein_dist_ind"]], "torchvinecopulib.vinecop": [[5, 1, 1, "", "DataVineCop"], [5, 5, 1, "", "vcp_from_json"], [5, 5, 1, "", "vcp_from_obs"], [5, 5, 1, "", "vcp_from_pth"]], "torchvinecopulib.vinecop.DataVineCop": [[5, 3, 1, "", "aic"], [5, 3, 1, "", "bic"], [5, 2, 1, "", "cdf"], [5, 4, 1, "", "dct_bcp"], [5, 4, 1, "", "dct_tree"], [5, 2, 1, "", "draw_dag"], [5, 2, 1, "", "draw_lv"], [5, 2, 1, "", "l_pdf"], [5, 3, 1, "", "matrix"], [5, 4, 1, "", "mtd_bidep"], [5, 3, 1, "", "negloglik"], [5, 3, 1, "", "num_dim"], [5, 3, 1, "", "num_obs"], [5, 3, 1, "", "num_par"], [5, 2, 1, "", "rosenblatt_transform"], [5, 2, 1, "", "sim"], [5, 4, 1, "", "tpl_sim"], [5, 2, 1, "", "vcp_to_json"], [5, 2, 1, "", "vcp_to_pth"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:attribute", "5": "py:function"}, "terms": {"": [3, 4, 5], "0": [3, 4, 5], "05": [3, 5], "09": 4, "1": [3, 4, 5], "10000": 5, "105270": 4, "110": 4, "116": 4, "180": [3, 4], "1e": 4, "2": [3, 4, 5], "2009": 4, "201": 4, "2013": [4, 5], "2020": 4, "2021": 4, "2022": 4, "2023": 4, "2024": 4, "24": 4, "270": [3, 4], "283": 4, "299": 4, "31": 4, "47": 4, "50": 4, "52": 5, "536": 4, "59": 5, "69": 5, "7": 5, "8": [4, 5], "90": [3, 4], "999": 4, "A": 4, "It": 4, "On": 4, "The": [3, 4, 5], "To": 4, "_clayton": 3, "_description_": 5, "_frank": 3, "_gaussian": 3, "_gumbel": 3, "_independ": 3, "_joe": 3, "_studentt": 3, "abc": [3, 5], "accur": 3, "acm": 4, "acycl": 5, "affect": 5, "aic": [2, 3, 5], "akaik": [3, 5], "all": 5, "alreadi": 5, "american": 4, "an": [3, 4, 5], "analysi": [4, 5], "applic": 5, "ar": [4, 5], "arbitrari": 4, "arrai": 5, "arrang": 5, "associ": 4, "assum": 4, "averag": 4, "avoid": [3, 4], "ax": 5, "b": [3, 4, 5], "b5797d7e4a71c71faf86df51f26ad0d8d551ad08": 4, "bandwidth": 4, "base": [3, 4, 5], "bayesian": [3, 5], "bcp_from_ob": [2, 3], "becaus": 4, "been": 4, "begin": 5, "below": [3, 5], "best": [3, 5], "between": 4, "bfg": [3, 5], "bic": [2, 3, 5], "bicop": [0, 1, 2, 4, 5], "bicopabstract": 3, "bicoparchimedean": 3, "bicopdata": 3, "bicopellipt": 3, "bidep": 5, "biometrika": 4, "bisect": 4, "bivari": [3, 4, 5], "blob": 4, "bool": [4, 5], "boost": 4, "both": 4, "brechmann": 5, "c": 5, "calcul": [3, 4, 5], "call": 5, "callabl": 4, "can": [3, 4, 5], "candid": [3, 5], "carlo": 5, "case": 4, "cdf": [2, 3, 4, 5], "cdf_0": [2, 3], "cdf_func_kernel": [2, 4], "chanc": 4, "character": 4, "chatterje": 4, "chatterjee_xi": [2, 4, 5], "class": [3, 4, 5], "classmethod": 3, "clayton": [2, 3, 5], "clockwis": 3, "cobyla": [3, 5], "coeffici": 4, "color": 5, "com": 4, "common": 4, "compon": 4, "comput": [4, 5], "cond": 5, "cond_set": 5, "condit": 5, "confirm": 4, "consist": 4, "construct": 5, "content": 1, "control": 4, "convert": 3, "copula": [3, 4, 5], "correl": 4, "correspond": [3, 5], "could": [3, 5], "counter": 3, "cpu": [3, 5], "criterion": [3, 5], "cross": 4, "cumul": [3, 4, 5], "curv": 4, "cvine": 5, "cxx": 4, "czado": 5, "d": 5, "dag": 5, "data": [3, 4, 5], "databicop": [2, 3, 5], "dataclass": [3, 5], "datavinecop": [2, 5], "dct_bcp": [2, 5], "dct_first_v": 5, "dct_tree": [2, 5], "deby": 4, "debye1": [2, 4], "deeper": 5, "default": [3, 4, 5], "degre": 3, "densiti": [3, 4, 5], "depend": [4, 5], "devic": [3, 5], "dict": 5, "digit": 5, "dimens": 5, "direct": 5, "dissmann": 5, "distanc": 4, "distribut": [3, 4, 5], "do": 4, "doc": 4, "doe": 4, "draw": 5, "draw_dag": [2, 5], "draw_lv": [2, 5], "dtype": [3, 5], "dure": 3, "dvine": 5, "e": 5, "each": [4, 5], "edg": 5, "either": [3, 5], "empir": 4, "empti": 5, "en": 4, "encourag": 4, "engag": 4, "enhanc": 4, "enum": [3, 4], "enum_fam_bicop": [2, 3], "enum_func_bidep": [2, 4], "eps_2": 4, "epsilon": 4, "estim": [3, 4, 5], "expens": 4, "experienc": 5, "explicitli": 5, "exponenti": 4, "f": 4, "f_path": 5, "factori": 3, "fals": 5, "fam": [2, 3], "famili": [3, 5], "fast": 4, "fastmi": 4, "feature_select": 4, "ferreira": 4, "ferreira_tail_dep_coeff": [2, 4, 5], "fig": 5, "fig_siz": 5, "figur": 5, "file": 5, "financi": 5, "first": [3, 5], "fit": [3, 4, 5], "flexibl": 5, "float": [3, 4, 5], "float64": [3, 5], "fn": 4, "follow": 5, "font": 5, "font_size_edg": 5, "font_size_vertex": 5, "frank": [2, 3, 5], "from": [3, 4, 5], "frozenset_cond": 5, "full": 5, "func": 4, "function": [3, 4, 5], "functool": 4, "further": [3, 5], "gaussian": [2, 3, 5], "gener": 4, "github": 4, "give": [4, 5], "given": [3, 5], "good": 4, "graph": 5, "grid": 4, "guarante": 4, "gumbel": [2, 3, 5], "h": [3, 4], "ha": [4, 5], "han": 4, "harder": 4, "hardwir": 4, "hfunc": 5, "hfunc1": [2, 3], "hfunc1_0": [2, 3], "hfunc2": [2, 3], "highlight": 5, "hinv": 5, "hinv1": [2, 3], "hinv1_0": [2, 3], "hinv2": [2, 3], "howev": 4, "html": 4, "http": 4, "i": [3, 4, 5], "ideal": 5, "ignor": [3, 5], "iid": 4, "impact": 4, "implement": 4, "indep": 4, "independ": [2, 3, 4, 5], "index": 0, "inform": [3, 4, 5], "insid": 4, "instanc": [3, 5], "instanti": 3, "int": [3, 4, 5], "integr": 4, "interest": 4, "interpret": 4, "invers": [3, 5], "is_bcp": 5, "is_dissmann": 5, "is_scott": 4, "is_sklearn": 4, "itau": [3, 5], "iter": 4, "itp": 4, "itp_method": 4, "j": 5, "j_max": 4, "joe": [2, 3, 5], "journal": 4, "json": 5, "k": 4, "k1": 4, "k2": 4, "k_1": 4, "k_2": 4, "kde": 4, "kendal": [3, 5], "kendall_tau": [2, 4, 5], "kept": 5, "kernel": 4, "kurbo": 4, "kurowicka": 5, "kwarg": 3, "l": [3, 5], "l_pdf": [2, 3, 5], "l_pdf_0": [2, 3], "label": 5, "larg": 4, "learn": 4, "left": 5, "length": 3, "level": 5, "lib": 4, "like": 4, "likelihood": [3, 5], "limit": 4, "lin": 4, "load": 5, "log": [3, 5], "lower": 4, "lv": 5, "m": 4, "mai": [4, 5], "major": 5, "make": 3, "manual_se": [3, 4, 5], "match": 4, "mathemat": 4, "matrix": [2, 5], "max": 4, "maximum": [3, 5], "measur": [4, 5], "method": [3, 4, 5], "minim": [3, 5], "minimum": 5, "minmax": 4, "mle": [3, 5], "model": [3, 5], "modifi": 3, "modul": [0, 1], "monoton": 4, "mont": 5, "more": 4, "mst": 5, "mtd_bidep": [2, 5], "mtd_fit": [3, 5], "mtd_mle": [3, 5], "mtd_opt": 3, "mtd_sel": [3, 5], "mtd_vine": 5, "multivari": [4, 5], "mutual": 4, "mutual_info": [2, 4, 5], "mutual_info_regress": 4, "n": [4, 5], "n0": 4, "n_0": 4, "name": [3, 5], "nan": 3, "ndarrai": 5, "nearest": 4, "necessari": 5, "neg": [3, 4, 5], "negloglik": [2, 3, 5], "neighbor": 4, "neither": 3, "new": 4, "nll": 5, "node": 5, "none": [3, 5], "nonparametr": 4, "nor": 3, "norm": 4, "notimplementederror": 3, "np": 5, "num": 4, "num_digit": 5, "num_dim": [2, 5], "num_ob": [2, 3, 5], "num_par": [2, 3, 5], "num_sim": [3, 5], "num_step": 4, "number": [3, 4, 5], "ob": [3, 4, 5], "object": [3, 5], "obs_bcp": 3, "obs_mvcp": 5, "observ": [3, 4, 5], "occur": 4, "oliveira": 4, "one": [3, 4, 5], "onli": 4, "openturn": 4, "optim": [3, 4, 5], "option": [3, 4, 5], "order": [4, 5], "org": 4, "ot": 4, "other": 5, "otherwis": 4, "p": [3, 4], "packag": [0, 1], "page": 0, "pair": 4, "pairwis": 4, "paper": 4, "par": [2, 3], "par2tau_0": [2, 3], "paramet": [3, 4, 5], "partial": 4, "path": 5, "pdf": [3, 5], "pdf_0": [2, 3], "per": 5, "perform": 4, "point": 4, "possibl": 4, "power": 4, "pp": 4, "prescrib": 5, "preserv": 4, "prev": 5, "priorit": 5, "prioriti": 5, "prob": 3, "probabl": [3, 5], "problem": 4, "properti": [3, 5], "pseudo": 5, "pth": 5, "purkayastha": 4, "q": 3, "quantil": 5, "r": 4, "rais": [3, 5], "rand": [3, 5], "random": [3, 4, 5], "rank": 4, "reach": 5, "read": 5, "record": 3, "recurs": 5, "refer": 4, "reg": 4, "regress": 5, "regular": [4, 5], "reject": [3, 5], "rel": 4, "requir": 4, "resembl": 4, "result": 4, "return": [3, 4, 5], "revis": 4, "right": [4, 5], "rosenblatt": 5, "rosenblatt_transform": [2, 5], "rot": [2, 3], "rotat": [3, 4], "round": 5, "row": 5, "rule": 4, "rvine": 5, "sampl": 4, "save": 5, "scikit": 4, "scipi": [3, 5], "scott": 4, "search": 0, "secant": 4, "second": 3, "seed": [3, 4, 5], "select": [3, 5], "self": [3, 5], "sequenti": 5, "set": 5, "set_cond": 5, "shallow": 5, "shape": [3, 4, 5], "sim": [2, 3, 5], "simul": [3, 5], "sinkhorn2": 4, "size": 5, "sklearn": 4, "smooth": 4, "so": 4, "softwar": 4, "solv": 4, "solve_itp": [2, 4], "some": 5, "song": 4, "sourc": [3, 4, 5], "span": 5, "specfunc": 4, "src": 4, "stabl": 4, "static": 3, "statist": [4, 5], "step": 4, "store": [3, 5], "str": [3, 5], "strength": 4, "strictli": 4, "structur": 5, "studentt": [2, 3, 5], "subpackag": 1, "subset": [3, 5], "suggest": 4, "sum": 5, "superior": 4, "symmetr": [3, 4], "tail": 4, "takahashi": 4, "taken": [3, 4, 5], "tau": [2, 3, 5], "tau2par": [2, 3], "tau2par_0": [2, 3], "tau_max": 4, "tau_min": 4, "tensor": [3, 4, 5], "test": [3, 4, 5], "than": 4, "thi": 4, "though": 4, "thresh_trunc": [3, 5], "threshold": [3, 5], "thu": 4, "titl": 5, "tom": 4, "top": 5, "topk": [3, 5], "torch": [3, 4, 5], "tpl_fam": [3, 5], "tpl_first": 5, "tpl_first_v": 5, "tpl_sim": [2, 5], "transact": 4, "transform": 5, "tree": 5, "triangular": 5, "true": [4, 5], "tune": 4, "tupl": [3, 5], "type": [3, 4, 5], "unexpect": 4, "uniform": 5, "until": 5, "upper": [4, 5], "upward": 5, "us": [3, 4, 5], "user": [4, 5], "util": [0, 1, 2], "v0": 3, "v1": 3, "v2": 3, "v_left": 3, "v_right": 3, "valu": [3, 4], "valueerror": 5, "vcp": 5, "vcp_from_json": [2, 5], "vcp_from_ob": [2, 5], "vcp_from_pth": [2, 5], "vcp_to_json": [2, 5], "vcp_to_pth": [2, 5], "vector": 4, "vertex": 5, "vertex_left": 5, "vertex_right": 5, "vertic": 5, "vine": 5, "vinecop": [0, 1, 2], "walk": 5, "wasserstein": 4, "wasserstein_dist_ind": [2, 4, 5], "we": [3, 5], "weight": 5, "well": 4, "when": [3, 4, 5], "where": 5, "whether": [4, 5], "which": [3, 5], "whose": 5, "wiki": 4, "wikipedia": 4, "windowspath": 5, "within": 4, "work": 4, "workflow": 5, "worst": 4, "x": 4, "y": 4, "yellow": 5, "z": 4, "zero": 4, "\u03bb": 4, "\u03be": 4}, "titles": ["Welcome to torchvinecopulib\u2019s documentation!", "torchvinecopulib", "torchvinecopulib package", "torchvinecopulib.bicop package", "torchvinecopulib.util package", "torchvinecopulib.vinecop package"], "titleterms": {"": 0, "bicop": 3, "content": [0, 2, 3, 4, 5], "document": 0, "indic": 0, "modul": [2, 3, 4, 5], "packag": [2, 3, 4, 5], "subpackag": 2, "tabl": 0, "torchvinecopulib": [0, 1, 2, 3, 4, 5], "util": 4, "vinecop": 5, "welcom": 0}}) \ No newline at end of file diff --git a/docs/_build/html/torchvinecopulib.bicop.html b/docs/_build/html/torchvinecopulib.bicop.html index cb74f98..5ffeaae 100644 --- a/docs/_build/html/torchvinecopulib.bicop.html +++ b/docs/_build/html/torchvinecopulib.bicop.html @@ -6,7 +6,7 @@ - torchvinecopulib.bicop package - torchvinecopulib 2024.4.2 documentation + torchvinecopulib.bicop package - torchvinecopulib 2024.5.0 documentation @@ -125,7 +125,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -148,7 +148,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -792,7 +792,7 @@

torchvinecopulib.bicop package

diff --git a/docs/_build/html/torchvinecopulib.html b/docs/_build/html/torchvinecopulib.html index baad025..294a0b7 100644 --- a/docs/_build/html/torchvinecopulib.html +++ b/docs/_build/html/torchvinecopulib.html @@ -6,7 +6,7 @@ - torchvinecopulib package - torchvinecopulib 2024.4.2 documentation + torchvinecopulib package - torchvinecopulib 2024.5.0 documentation @@ -125,7 +125,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -148,7 +148,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -417,7 +417,7 @@

Subpackages +

diff --git a/docs/_build/html/torchvinecopulib.util.html b/docs/_build/html/torchvinecopulib.util.html index a99fc89..46d399b 100644 --- a/docs/_build/html/torchvinecopulib.util.html +++ b/docs/_build/html/torchvinecopulib.util.html @@ -6,7 +6,7 @@ - torchvinecopulib.util package - torchvinecopulib 2024.4.2 documentation + torchvinecopulib.util package - torchvinecopulib 2024.5.0 documentation @@ -125,7 +125,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -148,7 +148,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -345,20 +345,21 @@

torchvinecopulib.util package
-torchvinecopulib.util.wasserstein_dist_ind(x: Tensor, y: Tensor, reg: float = 0.1, p: int = 2, seed: int = 0, num_sim: int = 2) → float[source]
-

Wasserstein distance from bicop obs to indep bicop simulations, by ot.sinkhorn2 (averaged for each observation).

+torchvinecopulib.util.wasserstein_dist_ind(x: Tensor, y: Tensor, p: int = 2, reg: float = 0.1, num_step: int = 50, seed: int = 0) → float[source] +

Wasserstein distance from bicop obs to indep bicop, by ot.sinkhorn2 (averaged for each observation).

Parameters:

  • x (torch.Tensor) – copula obs of shape (n,1)

  • y (torch.Tensor) – copula obs of shape (n,1)

    • +

  • p (int, optional) – p-norm to calculate distance between each vector pair, defaults to 2

  • reg (float, optional) – regularization strength, defaults to 0.1

    • -

  • p (int, optional) – p-norm distance to calculate between each vector pair, defaults to 2

    • -

  • seed (int, optional) – random seed for torch.manual_seed() in indep bicop simulations, defaults to 0

    • +

  • num_step (int, optional) – number of steps in the independent bivariate copula grid, defaults to 50

    • +

  • seed (int, optional) – random seed for torch.manual_seed(), defaults to 0

Returns:
-

Wasserstein distance from bicop obs to indep bicop simulations

+

Wasserstein distance from bicop obs to indep bicop

Return type:

float

@@ -447,7 +448,7 @@

torchvinecopulib.util package +

diff --git a/docs/_build/html/torchvinecopulib.vinecop.html b/docs/_build/html/torchvinecopulib.vinecop.html index d31c204..ef51012 100644 --- a/docs/_build/html/torchvinecopulib.vinecop.html +++ b/docs/_build/html/torchvinecopulib.vinecop.html @@ -6,7 +6,7 @@ - torchvinecopulib.vinecop package - torchvinecopulib 2024.4.2 documentation + torchvinecopulib.vinecop package - torchvinecopulib 2024.5.0 documentation @@ -125,7 +125,7 @@
-
torchvinecopulib 2024.4.2 documentation
 +
torchvinecopulib 2024.5.0 documentation
@@ -148,7 +148,7 @@
- torchvinecopulib 2024.4.2 documentation + torchvinecopulib 2024.5.0 documentation @@ -273,7 +273,7 @@

torchvinecopulib.vinecop package
-draw_dag(tpl_first_vs: tuple = (), tpl_sim: tuple = (), font_size_vertex: int = 8, f_path: Path | None = None, fig_size: tuple | None = None) → tuple[source]
+draw_dag(tpl_first_vs: tuple = (), tpl_sim: tuple = (), title: str = 'Vine Copula, Obs and BiCop', font_size_vertex: int = 8, f_path: Path | None = None, fig_size: tuple | None = None) → tuple[source]

draw the directed acyclic graph (DAG) of the vine copula, with pseudo observations and bicops as nodes. The source nodes in simulation workflow are highlighted in yellow.

@@ -399,7 +399,7 @@

torchvinecopulib.vinecop package
-rosenblatt_transform(obs_mvcp: Tensor, tpl_sim: tuple = ()) → Tensor[source]
+rosenblatt_transform(obs_mvcp: Tensor, tpl_sim: tuple = ()) → dict[source]

Rosenblatt transformation, from the multivariate copula (with dependence) to the uniform multivariate copula (independent), using constructed vine copula

@@ -414,7 +414,7 @@

torchvinecopulib.vinecop package

ideally independent uniform multivariate copula, of shape (num_obs, num_dim)

Return type:
-

torch.Tensor

+

dict

@@ -674,7 +674,7 @@

torchvinecopulib.vinecop package +

diff --git a/pyproject.toml b/pyproject.toml index b729497..d26b5f8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,7 +2,7 @@ package-mode = true license = "GNU GPLv3" name = "torchvinecopulib" -version = "2024.4.2" +version = "2024.5.0" description = "yet another vine copula library for PyTorch." authors = ["Tuoyuan Cheng "] maintainers = ["Xiaosheng You "] diff --git a/torchvinecopulib/bicop/_factory_bcp.py b/torchvinecopulib/bicop/_factory_bcp.py index a2ec1da..b46c99d 100644 --- a/torchvinecopulib/bicop/_factory_bcp.py +++ b/torchvinecopulib/bicop/_factory_bcp.py @@ -29,7 +29,7 @@ def bcp_from_obs( :type obs_bcp: torch.Tensor :param tau: Kendall's tau of the observations, defaults to None for the function to estimate :type tau: float, optional - :param thresh_trunc: threshold of Kendall's tau independence test, below which we reject independent bicop, defaults to 0.1 + :param thresh_trunc: threshold of Kendall's tau independence test, below which we reject independent bicop, defaults to 0.05 :type thresh_trunc: float, optional :param mtd_fit: parameter estimation method, either 'itau' (inverse of tau) or 'mle' (maximum likelihood estimation); defaults to "itau" diff --git a/torchvinecopulib/util/__init__.py b/torchvinecopulib/util/__init__.py index 4c5e7a9..abf05c2 100644 --- a/torchvinecopulib/util/__init__.py +++ b/torchvinecopulib/util/__init__.py @@ -1,9 +1,10 @@ import math from enum import Enum from functools import partial +from itertools import product import torch -from scipy.stats import t, kendalltau +from scipy.stats import kendalltau, t __all__ = [ "ENUM_FUNC_BIDEP", @@ -156,49 +157,50 @@ def xy_sum(m: int) -> tuple: def wasserstein_dist_ind( x: torch.Tensor, y: torch.Tensor, - reg: float = 0.1, p: int = 2, + reg: float = 0.1, + num_step: int = 50, seed: int = 0, - num_sim: int = 2, ) -> float: - """Wasserstein distance from bicop obs to indep bicop simulations, by ot.sinkhorn2 (averaged for each observation). + """Wasserstein distance from bicop obs to indep bicop, by ot.sinkhorn2 (averaged for each observation). :param x: copula obs of shape (n,1) :type x: torch.Tensor :param y: copula obs of shape (n,1) :type y: torch.Tensor + :param p: p-norm to calculate distance between each vector pair, defaults to 2 + :type p: int, optional :param reg: regularization strength, defaults to 0.1 :type reg: float, optional - :param p: p-norm distance to calculate between each vector pair, defaults to 2 - :type p: int, optional - :param seed: random seed for torch.manual_seed() in indep bicop simulations, defaults to 0 + :param num_step: number of steps in the independent bivariate copula grid, defaults to 50 + :type num_step: int, optional + :param seed: random seed for torch.manual_seed(), defaults to 0 :type seed: int, optional - :return: Wasserstein distance from bicop obs to indep bicop simulations + :return: Wasserstein distance from bicop obs to indep bicop :rtype: float """ from ot import sinkhorn2 torch.manual_seed(seed=seed) - X_s = torch.hstack([x, y]) - num_obs = x.shape[0] - a, b = ( - torch.ones(size=(num_obs, 1), device=x.device, dtype=x.dtype) / num_obs, - torch.ones(size=(num_obs, 1), device=x.device, dtype=x.dtype) / num_obs, - ) - return ( - sum( - ( - sinkhorn2( - a=a, - b=b, - M=torch.cdist(X_s, torch.rand_like(X_s), p=p), - reg=reg, - ).item() - for _ in range(num_sim) - ) - ) - / num_sim - ) + return sinkhorn2( + a=torch.ones_like(x) / x.shape[0], + b=torch.ones(size=(num_step**2, 1), device=x.device, dtype=x.dtype) / num_step**2, + M=torch.cdist( + x1=torch.hstack([x, y]), + x2=torch.as_tensor( + ( + *product( + torch.linspace(0, 1, num_step), + torch.linspace(0, 1, num_step), + ), + ), + device=x.device, + dtype=x.dtype, + ), + p=p, + ), + reg=reg, + ).item() class ENUM_FUNC_BIDEP(Enum): diff --git a/torchvinecopulib/vinecop/_data_vcp.py b/torchvinecopulib/vinecop/_data_vcp.py index 5106097..aae4f34 100644 --- a/torchvinecopulib/vinecop/_data_vcp.py +++ b/torchvinecopulib/vinecop/_data_vcp.py @@ -335,6 +335,7 @@ def draw_dag( self, tpl_first_vs: tuple = tuple(), tpl_sim: tuple = tuple(), + title: str = "Vine Copula, Obs and BiCop", font_size_vertex: int = 8, f_path: Path = None, fig_size: tuple = None, @@ -363,7 +364,7 @@ def draw_dag( fig, ax = plt.subplots(nrows=1, ncols=1, figsize=fig_size) ax.set_title( - label="Vine Copula, Obs and BiCop", + label=title, fontsize=font_size_vertex + 1, ) G = nx.DiGraph() @@ -470,6 +471,7 @@ def draw_dag( alpha=0.8, ) fig.tight_layout() + plt.box(False) plt.draw_if_interactive() if f_path: fig.savefig(fname=f_path, bbox_inches="tight") @@ -591,7 +593,7 @@ def rosenblatt_transform( self, obs_mvcp: torch.Tensor, tpl_sim: tuple = tuple(), - ) -> torch.Tensor: + ) -> dict: """Rosenblatt transformation, from the multivariate copula (with dependence) to the uniform multivariate copula (independent), using constructed vine copula @@ -601,7 +603,7 @@ def rosenblatt_transform( gives flexibility to experienced users, defaults to tuple() :type tpl_sim: tuple, optional :return: ideally independent uniform multivariate copula, of shape (num_obs, num_dim) - :rtype: torch.Tensor + :rtype: dict """ num_dim = self.num_dim if not tpl_sim: