Skip to content

Commit c6685e6

Browse files
committed
fix docs
1 parent ba3c0a2 commit c6685e6

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

docs/sources/CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The CHANGELOG for the current development version is available at
2121
- The `SequentialFeatureSelector` is now also compatible with Pandas DataFrames and uses DataFrame column-names for more interpretable feature subset reports. ([#379](https://github.com/rasbt/mlxtend/pull/379))
2222
- `ColumnSelector` now works with Pandas DataFrames columns. ([#378](https://github.com/rasbt/mlxtend/pull/378) by [Manuel Garrido](https://github.com/manugarri))
2323
- The `ExhaustiveFeatureSelector` estimator in `mlxtend.feature_selection` now is safely stoppable mid-process by control+c. ([#380](https://github.com/rasbt/mlxtend/pull/380))
24-
- Two new functions, `vectorspace_orthonormalization` and `vectorspace_dimensionality` were added to `mlxtend.math` to use the Gram-Schmidt process to convert an orthogonal vectorspace into orthonormal basis vectors and to compute the dimensionality of a vectorspace, respectively. ([#382](https://github.com/rasbt/mlxtend/pull/382))
24+
- Two new functions, `vectorspace_orthonormalization` and `vectorspace_dimensionality` were added to `mlxtend.math` to use the Gram-Schmidt process to convert a set of linearly independent vectors into a set of orthonormal basis vectors, and to compute the dimensionality of a vectorspace, respectively. ([#382](https://github.com/rasbt/mlxtend/pull/382))
2525

2626

2727
##### Changes

docs/sources/user_guide/math/vectorspace_dimensionality.ipynb

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"cell_type": "markdown",
3333
"metadata": {},
3434
"source": [
35-
"Given a set of vectors, arranged as columns in a matrix, the `vectorspace_dimensionality` computes the number of dimensions (i.e., hyper-volume) that the vectorspace spans using the Gram-Schmidt process [1]. In particular, since the Gram-Schmidt process yields vectors that are zero or normalized to 1 (i.e., an orthonormal vectorset if the input was an orthogonal vectorset), the sum of the vector norms corresponds to the number of dimensions of a vectorset. "
35+
"Given a set of vectors, arranged as columns in a matrix, the `vectorspace_dimensionality` computes the number of dimensions (i.e., hyper-volume) that the vectorspace spans using the Gram-Schmidt process [1]. In particular, since the Gram-Schmidt process yields vectors that are zero or normalized to 1 (i.e., an orthonormal vectorset if the input was a set of linearly independent vectors), the sum of the vector norms corresponds to the number of dimensions of a vectorset. "
3636
]
3737
},
3838
{
@@ -203,7 +203,7 @@
203203
"\n",
204204
"- `ary` : array-like, shape=[num_vectors, num_vectors]\n",
205205
"\n",
206-
" An orthogonal set of vectors (arranged as columns in a matrix)\n",
206+
" A set of vectors (arranged as columns in a matrix)\n",
207207
"\n",
208208
"**Returns**\n",
209209
"\n",

docs/sources/user_guide/math/vectorspace_orthonormalization.ipynb

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"cell_type": "markdown",
1212
"metadata": {},
1313
"source": [
14-
"A function that converts a set of orthogonal vectors to a set of orthonormal basis vectors."
14+
"A function that converts a set of linearly independent vectors to a set of orthonormal basis vectors."
1515
]
1616
},
1717
{
@@ -32,7 +32,7 @@
3232
"cell_type": "markdown",
3333
"metadata": {},
3434
"source": [
35-
"The `vectorspace_orthonormalization` converts a set of orthogonal vectors to a set of orthonormal basis vectors using the Gram-Schmidt process [1]. "
35+
"The `vectorspace_orthonormalization` converts a set linearly independent vectors to a set of orthonormal basis vectors using the Gram-Schmidt process [1]. "
3636
]
3737
},
3838
{
@@ -55,7 +55,7 @@
5555
"cell_type": "markdown",
5656
"metadata": {},
5757
"source": [
58-
"Note that to convert a set of orthogonal vectors into a set of orthonormal basis vectors, the `vectorspace_orthonormalization` function expects the vectors to be arranged as columns of a matrix (here: NumPy array). Please keep in mind that the `vectorspace_orthonormalization` function also works for non orthogonal vector sets; however, the resulting vectorset won't be orthonormal as a result. An easy way to check whether all vectors in the input set are orthogonal is to use the `numpy.linalg.det` (determinant) function."
58+
"Note that to convert a set of linearly independent vectors into a set of orthonormal basis vectors, the `vectorspace_orthonormalization` function expects the vectors to be arranged as columns of a matrix (here: NumPy array). Please keep in mind that the `vectorspace_orthonormalization` function also works for non-linearly independent vector sets; however, the resulting vectorset won't be orthonormal as a result. An easy way to check whether all vectors in the input set are linearly independent is to use the `numpy.linalg.det` (determinant) function."
5959
]
6060
},
6161
{
@@ -137,7 +137,7 @@
137137
"cell_type": "markdown",
138138
"metadata": {},
139139
"source": [
140-
"However, in case of linear dependence(the second column is a linear combination of the first column in the example below), the vector elements of one of the dependent vectors will become zero. (For a pair of linear dependent vectors, the one with the larger column index will be the one that's zero-ed.)"
140+
"However, in case of linear dependence (the second column is a linear combination of the first column in the example below), the vector elements of one of the dependent vectors will become zero. (For a pair of linear dependent vectors, the one with the larger column index will be the one that's zero-ed.)"
141141
]
142142
},
143143
{
@@ -186,15 +186,15 @@
186186
"\n",
187187
"Transforms a set of column vectors to a orthonormal basis.\n",
188188
"\n",
189-
"Given a set of orthogonal vectors, this functions converts such\n",
189+
"Given a set of linearly independent vectors, this functions converts such\n",
190190
"column vectors, arranged in a matrix, into orthonormal basis\n",
191191
"vectors.\n",
192192
"\n",
193193
"**Parameters**\n",
194194
"\n",
195195
"- `ary` : array-like, shape=[num_vectors, num_vectors]\n",
196196
"\n",
197-
" An orthogonal set of vectors (arranged as columns in a matrix)\n",
197+
" A set of vectors (arranged as columns in a matrix)\n",
198198
"\n",
199199
"\n",
200200
"- `eps` : float (default: 1e-13)\n",

0 commit comments

Comments
 (0)