Skip to content

Commit 637abe5

Browse files
authored
Updated doc strings and dependencies (#11)
Co-authored-by: Ole-Christian Galbo Engstrøm <ocge@foss.dk>
1 parent f932b3b commit 637abe5

File tree

6 files changed

+80
-64
lines changed

6 files changed

+80
-64
lines changed

.github/workflows/pull_request_test_workflow.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
fail-fast: false
1818
matrix:
1919
os: [ubuntu-latest, windows-latest, macos-latest]
20-
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
20+
python-version: ["3.11", "3.12", "3.13"]
2121
exclude:
2222
- os: windows-latest
2323
python-version: "3.13"

.github/workflows/test_workflow.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
fail-fast: false
1818
matrix:
1919
os: [ubuntu-latest, windows-latest, macos-latest]
20-
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
20+
python-version: ["3.11", "3.12", "3.13"]
2121
exclude:
2222
- os: windows-latest
2323
python-version: "3.13"

cvmatrix/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "3.0.0.post1"
1+
__version__ = "3.1.0"

cvmatrix/cvmatrix.py

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -100,29 +100,39 @@ class CVMatrix:
100100
entire dataset. This is computed only if `Y` is not `None`.
101101
102102
sum_X : np.ndarray or None
103-
The row of column-wise weighted means for `X` for the entire dataset. This is
104-
computed only if `center_X`, `scale_X`, or `center_Y` is `True`.
103+
The row of column-wise weighted sums of `X` for the entire dataset. This is
104+
computed only if `center_X`, `scale_X`, or `center_Y` is `True`. This is the
105+
row of column-wise sums of :math:`\mathbf{W}\mathbf{X}` if `weights` are
106+
provided and otherwise the row of column-wise sums of :math:`\mathbf{X}`.
105107
106108
sum_Y : np.ndarray or None
107-
The row of column-wise weighted means for `Y` for the entire dataset. This is
109+
The row of column-wise weighted sums of `Y` for the entire dataset. This is
108110
computed only if `center_Y`, `scale_Y`, or `center_X` is `True` and `Y` is not
109-
`None`.
111+
`None`. This is the row of column-wise sums of :math:`\mathbf{W}\mathbf{Y}` if
112+
`weights` are provided and otherwise the row of column-wise sums of
113+
:math:`\mathbf{Y}`.
110114
111115
sum_sq_X : np.ndarray or None
112-
The row of column-wise weighted standard deviations for `X` for the entire
113-
dataset. This is computed only if `scale_X` is `True`.
116+
The row of column-wise weighted squared sums of `X` for the entire dataset.
117+
This is computed only if `scale_X` is `True`. This is the
118+
row of column-wise sums of :math:`\mathbf{W}\mathbf{X}\odot\mathbf{X}` if
119+
`weights` are provided and otherwise the row of column-wise sums of
120+
:math:`\mathbf{X}\odot\mathbf{X}`.
114121
115122
sum_sq_Y : np.ndarray or None
116-
The row of column-wise weighted standard deviations for `Y` for the entire
117-
dataset. This is computed only if `scale_Y` is `True` and `Y` is not `None`.
123+
The row of column-wise weighted squared sums of `Y` for the entire dataset.
124+
This is computed only if `scale_Y` is `True` and `Y` is not `None`. This is the
125+
row of column-wise sums of :math:`\mathbf{W}\mathbf{Y}\odot\mathbf{Y}` if
126+
`weights` are provided and otherwise the row of column-wise sums of
127+
:math:`\mathbf{Y}\odot\mathbf{Y}`.
118128
119129
Xw : np.ndarray or None
120130
The total weighted predictor matrix `X` for the entire dataset. This is
121-
:math:`\mathbf{X}\mathbf{W}`.
131+
:math:`\mathbf{W}\mathbf{X}`.
122132
123133
Yw : np.ndarray or None
124134
The total weighted response matrix `Y` for the entire dataset. This is
125-
:math:`\mathbf{Y}\mathbf{W}`. This is computed only if `Y` is not `None`.
135+
:math:`\mathbf{W}\mathbf{Y}`. This is computed only if `Y` is not `None`.
126136
127137
weights : np.ndarray or None
128138
The total weights for the entire dataset. This is an array of shape (N, 1). If

poetry.lock

Lines changed: 55 additions & 49 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "cvmatrix"
3-
version = "3.0.0.post1"
3+
version = "3.1.0"
44
description = "Fast computation of possibly weighted and possibly centered/scaled training set kernel matrices in a cross-validation setting."
55
authors = ["Sm00thix <oleemail@icloud.com>"]
66
maintainers = ["Sm00thix <oleemail@icloud.com>"]
@@ -10,7 +10,7 @@ homepage = "https://cvmatrix.readthedocs.io/en/latest/"
1010
repository = "https://github.com/Sm00thix/CVMatrix"
1111

1212
[tool.poetry.dependencies]
13-
python = ">=3.9, <3.14"
13+
python = ">=3.11, <3.14"
1414
numpy = "^2.0.0"
1515

1616
[build-system]

0 commit comments

Comments
 (0)