Skip to content

Commit 44bbef3

Browse files
authored
Update README.md
Updated comment above weights in README to provide more detail about the requirements for the weights parameter.
1 parent 4fcf30a commit 44bbef3

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,10 @@ The `cvmatrix` software package now also features **weigthed matrix produts** $\
5050
> Y = np.random.uniform(size=(N, M)) # Random Y data
5151
> folds = np.arange(100) % 5 # 5-fold cross-validation
5252
>
53-
> # Weights must be non-negative and the sum of weights for any training partition must
54-
> # be greater than zero.
53+
> # Weights must be non-negative. If centering or scaling is used, the sum of weights
54+
> # for any training partition must be greater than zero. If scaling is used, the
55+
> # number of non-negative weights for any training partition must be greater than
56+
> # the ddof provided in the constructor.
5557
> weights = np.random.uniform(size=(N,)) + 0.1
5658
>
5759
> # Instantiate CVMatrix
@@ -115,4 +117,4 @@ Guidelines](https://github.com/Sm00thix/CVMatrix/blob/main/CONTRIBUTING.md).
115117
116118
## Funding
117119
- Up until May 31st 2025, this work has been carried out as part of an industrial Ph. D. project receiving funding from [FOSS Analytical A/S](https://www.fossanalytics.com/) and [The Innovation Fund Denmark](https://innovationsfonden.dk/en). Grant number 1044-00108B.
118-
- From June 1st 2025 and onward, this work is sponsored by [FOSS Analytical A/S](https://www.fossanalytics.com/).
120+
- From June 1st 2025 and onward, this work is sponsored by [FOSS Analytical A/S](https://www.fossanalytics.com/).

0 commit comments

Comments
 (0)