From 2748ef1c05618558265b3d020b2b9b212b6ad628 Mon Sep 17 00:00:00 2001 From: Anes Benmerzoug Date: Tue, 19 Mar 2024 14:41:34 +0100 Subject: [PATCH 1/3] Fix link, add k-fac abbreviation --- docs/getting-started/installation.md | 2 +- docs_includes/abbreviations.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 485b2742b..a048cc11b 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -76,7 +76,7 @@ that can be optionally installed: pip install pyDVL[ray] ``` - see [[getting-started#ray]] for more details on how to use it. + see [[first-steps#ray]] for more details on how to use it. - `memcached`: diff --git a/docs_includes/abbreviations.md b/docs_includes/abbreviations.md index b5e837007..aa47c405c 100644 --- a/docs_includes/abbreviations.md +++ b/docs_includes/abbreviations.md @@ -21,4 +21,5 @@ *[WAD]: Weighted Accuracy Drop *[OOB]: Out-of-Bag *[CG]: Conjugate Gradient -*[EKFAC]: Eigenvalue-corrected Kronecker Factorization +*[K-FAC]: Kronecker-Factored Approximate Curvature +*[EKFAC]: Eigenvalue-corrected Kronecker-Factored Approximate Curvature From abad3063f8416ffdb3473c05fc9f6f59b8884ede Mon Sep 17 00:00:00 2001 From: Anes Benmerzoug Date: Tue, 19 Mar 2024 14:54:46 +0100 Subject: [PATCH 2/3] Fix rendered text for some links --- docs/getting-started/installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index a048cc11b..ad8364ea3 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -33,7 +33,7 @@ pyDVL requires Python >= 3.8, [numpy](https://numpy.org/), [cvxpy](https://www.cvxpy.org/) for the Core methods, and [joblib](https://joblib.readthedocs.io/en/stable/) for parallelization locally. Additionally,the [Influence functions][pydvl.influence] -module requires PyTorch (see [[installation#extras]]). +module requires PyTorch (see [[installation#extras|Extras]]). ### Extras @@ -76,7 +76,7 @@ that can be optionally installed: pip install pyDVL[ray] ``` - see [[first-steps#ray]] for more details on how to use it. + see [[first-steps#ray|Ray Usage]] for more details on how to use it. - `memcached`: From cc84c9b649461cd2d37461db95de44971423616b Mon Sep 17 00:00:00 2001 From: Anes Benmerzoug Date: Tue, 19 Mar 2024 14:56:40 +0100 Subject: [PATCH 3/3] Update changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7bcbde1da..81e106641 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,7 +19,7 @@ - Bump versions of CI actions to avoid warnings [PR #502](https://github.com/aai-institute/pyDVL/pull/502) - Add Python Version 3.11 to supported versions [PR #510](https://github.com/aai-institute/pyDVL/pull/510) -- Documentation improvements and cleanup [PR #521](https://github.com/aai-institute/pyDVL/pull/521) +- Documentation improvements and cleanup [PR #521](https://github.com/aai-institute/pyDVL/pull/521) [PR #522](https://github.com/aai-institute/pyDVL/pull/522) ## 0.8.1 - 🆕 🏗 New method and notebook, Games with exact shapley values, bug fixes and cleanup