diff --git a/LICENSE b/LICENSE index 6b339e4..04a55a7 100644 --- a/LICENSE +++ b/LICENSE @@ -632,7 +632,7 @@ state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. torchvinecopulib, a vine copula package using PyTorch - Copyright (C) 2024- Tuoyuan Cheng, Xiaosheng You, Kan Chen + Copyright (C) 2024- Tuoyuan Cheng, Kan Chen This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: - torchvinecopulib Copyright (C) 2024- Tuoyuan Cheng, Xiaosheng You, Kan Chen + torchvinecopulib Copyright (C) 2024- Tuoyuan Cheng, Kan Chen This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. diff --git a/README.md b/README.md index aed6bac..09b3632 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,13 @@ [](https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/python-package.yml) [](https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/static.yml) -[](https://devguide.python.org/versions/#versions) -[](https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/python-package.yml) + +[](https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/python-package.yml) -[](https://www.gnu.org/licenses/gpl-3.0) -[](https://pypi.org/project/torchvinecopulib/) + + [](https://zenodo.org/doi/10.5281/zenodo.10836953) - Yet another vine copula package, using [PyTorch](https://pytorch.org/get-started/locally/). - C/D/R-Vine full-simulation/ quantile-regression/ conditional-simulation, all in one package @@ -28,7 +26,7 @@ Yet another vine copula package, using [PyTorch](https://pytorch.org/get-started ```toml # inside the `./pyproject.toml` file; -numpy = "<2" +numpy = "*" python = "^3.10" scipy = "*" # optional to facilitate customization @@ -49,9 +47,11 @@ python -c "import torch; print(torch.cuda.is_available())" ## Installation - By `pip` from [`PyPI`](https://pypi.org/project/torchvinecopulib/): + ```bash pip install torchvinecopulib torch ``` + - Or with full drawing and bivariate dependency metric support: ```bash @@ -59,22 +59,23 @@ pip install torchvinecopulib torch matplotlib pot scikit-learn ``` - Or `pip` from `./dist/*.whl` or `./dist/*.tar.gz` in this repo. -Need to use proper file name. + Need to use proper file name. ```bash # inside project root folder -pip install ./dist/torchvinecopulib-2024.9.0-py3-none-any.whl +pip install ./dist/torchvinecopulib-2024.10.0-py3-none-any.whl # or -pip install ./dist/torchvinecopulib-2024.9.0.tar.gz +pip install ./dist/torchvinecopulib-2024.10.0.tar.gz ``` ### (Optional) [Poetry](https://python-poetry.org/docs/) for Dependency Management and Packaging + After `git clone https://github.com/TY-Cheng/torchvinecopulib.git`, `cd` into the project root where [`pyproject.toml`](https://github.com/TY-Cheng/torchvinecopulib/blob/main/pyproject.toml) exists, ```bash # inside project root folder poetry lock && poetry install -E dev_cpu --with dev_cpu --sync -# or +# or poetry lock && poetry install -E dev_cuda --with dev_cuda --sync ``` @@ -110,6 +111,7 @@ coverage run -m pytest ./tests && coverage html ``` ## TODO + - more (non-parametric) `bicop` class in `torch` - port to TensorFlow Probability for `cuda`-compatible [Student's t cdf/ppf](https://www.tensorflow.org/probability/api_docs/python/tfp/distributions/StudentT) @@ -136,10 +138,9 @@ We welcome contributions, whether it's a bug report, feature suggestion, code co - [in-place ops can be slower](https://discuss.pytorch.org/t/are-inplace-operations-faster/61209/4) - [torch.jit.script can be slower](https://discuss.pytorch.org/t/why-is-torch-jit-script-slower/120131/6) - ## License -> Copyright (C) 2024 Tuoyuan Cheng, Xiaosheng You, Kan Chen +> Copyright (C) 2024- Tuoyuan Cheng, Kan Chen > > This file is part of torchvinecopulib. > torchvinecopulib is free software: you can redistribute it and/or modify diff --git a/dist/torchvinecopulib-2024.10.0-py3-none-any.whl b/dist/torchvinecopulib-2024.10.0-py3-none-any.whl new file mode 100644 index 0000000..225651d Binary files /dev/null and b/dist/torchvinecopulib-2024.10.0-py3-none-any.whl differ diff --git a/dist/torchvinecopulib-2024.10.0.tar.gz b/dist/torchvinecopulib-2024.10.0.tar.gz new file mode 100644 index 0000000..91bb407 Binary files /dev/null and b/dist/torchvinecopulib-2024.10.0.tar.gz differ diff --git a/dist/torchvinecopulib-2024.8.0-py3-none-any.whl b/dist/torchvinecopulib-2024.8.0-py3-none-any.whl deleted file mode 100644 index 4d0cf94..0000000 Binary files a/dist/torchvinecopulib-2024.8.0-py3-none-any.whl and /dev/null differ diff --git a/dist/torchvinecopulib-2024.8.0.tar.gz b/dist/torchvinecopulib-2024.8.0.tar.gz deleted file mode 100644 index d56e4f8..0000000 Binary files a/dist/torchvinecopulib-2024.8.0.tar.gz and /dev/null differ diff --git a/dist/torchvinecopulib-2024.9.0-py3-none-any.whl b/dist/torchvinecopulib-2024.9.0-py3-none-any.whl deleted file mode 100644 index e7d5e30..0000000 Binary files a/dist/torchvinecopulib-2024.9.0-py3-none-any.whl and /dev/null differ diff --git a/dist/torchvinecopulib-2024.9.0.tar.gz b/dist/torchvinecopulib-2024.9.0.tar.gz deleted file mode 100644 index 3c3f691..0000000 Binary files a/dist/torchvinecopulib-2024.9.0.tar.gz and /dev/null differ diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo index 3db35fd..4e492ec 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: e36efb9701b42e97c69e435b920b8c9f +config: fd7ece03e391b3f3cb0331c9f87c12ae tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html index 93f1a89..06c98e1 100644 --- a/docs/_build/html/_modules/index.html +++ b/docs/_build/html/_modules/index.html @@ -5,7 +5,7 @@ -
n_neighbors=3,
copy=True,
random_state=None,
- )[0]
+ )[0].item()
else:
# Purkayastha, S., & Song, P. X. K. (2024).
from fastkde.fastKDE import pdf_at_points
@@ -1173,7 +1181,7 @@ Source code for torchvinecopulib.util
-