From 18858da3e96ee5b931c835ebb4dd840b666c9ea6 Mon Sep 17 00:00:00 2001 From: Anes Benmerzoug Date: Fri, 1 Sep 2023 15:42:09 +0200 Subject: [PATCH 1/5] Add more abbreviations --- docs_includes/abbreviations.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs_includes/abbreviations.md b/docs_includes/abbreviations.md index cc2990534..e0fa67a4c 100644 --- a/docs_includes/abbreviations.md +++ b/docs_includes/abbreviations.md @@ -9,3 +9,7 @@ *[MSE]: Mean Squared Error *[SV]: Shapley Value *[TMCS]: Truncated Monte Carlo Shapley +*[IF]: Influence Function +*[iHVP]: inverse Hessian-vector product +*[LiSSA]: Linear-time Stochastic Second-order Algorithm +*[DUL]: Data Utility Learning From 6b947242f30e95150d59997b5487abdc4aa4579c Mon Sep 17 00:00:00 2001 From: Anes Benmerzoug Date: Fri, 1 Sep 2023 15:42:22 +0200 Subject: [PATCH 2/5] Small docs fixes --- docs/value/index.md | 5 ++--- docs/value/semi-values.md | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/value/index.md b/docs/value/index.md index 82aa72252..9877fac80 100644 --- a/docs/value/index.md +++ b/docs/value/index.md @@ -76,7 +76,7 @@ there are additional desiderata, like having a value function that does not increase with repeated samples. Game-theoretic methods are all rooted in axioms that by construction ensure different desiderata, but despite their practical usefulness, none of them are either necessary or sufficient for all -applications. For instance, *[SV]s try to equitably distribute all value +applications. For instance, SV methods try to equitably distribute all value among all samples, failing to identify repeated ones as unnecessary, with e.g. a zero value. @@ -332,8 +332,7 @@ nature of every (non-trivial) ML problem can have an effect: [@wang_data_2022] prove that by relaxing one of the Shapley axioms and considering the general class of semi-values, of which Shapley is an instance, one can prove that a choice of constant weights is the best one can - do in a utility-agnostic setting. So-called *Data Banzhaf* is on our to-do - list! + do in a utility-agnostic setting. So-called *Data Banzhaf*. * **Data set size**: Computing exact Shapley values is NP-hard, and Monte Carlo approximations can converge slowly. Massive datasets are thus impractical, at diff --git a/docs/value/semi-values.md b/docs/value/semi-values.md index 86513a6a1..2f1ea7a9c 100644 --- a/docs/value/semi-values.md +++ b/docs/value/semi-values.md @@ -117,7 +117,7 @@ values = compute_generic_semivalues( u=utility, coefficient=beta_coefficient(alpha=1, beta=16), done=AbsoluteStandardError(threshold=1e-4), - ) +) ``` Allowing any coefficient can help when experimenting with models which are more From 44ca42d5bbfb237b258ca29b13f607e443c40230 Mon Sep 17 00:00:00 2001 From: Anes Benmerzoug Date: Fri, 1 Sep 2023 15:44:57 +0200 Subject: [PATCH 3/5] Update changelog --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index fc7b3f163..92f101eec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +## Unreleased + +- Added more abbreviations to documentation + [PR #415](https://github.com/aai-institute/pyDVL/pull/415) + ## 0.7.0 - 📚 Documentation overhaul, new methods and bug fixes 💥 This is our first β release! We have worked hard to deliver improvements across From 92c0a7f5d98034b9244ba5d557308238512214c5 Mon Sep 17 00:00:00 2001 From: Anes Benmerzoug Date: Fri, 1 Sep 2023 15:53:08 +0200 Subject: [PATCH 4/5] Add section about Abbreviations to contributing docs --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6c334b00a..b7d4bf23a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -250,6 +250,16 @@ def f(x: float) -> float: return 1/(x*x) ``` +### Abbreviations + +We keep the abbreviations used in the documentation inside the +[docs_include/abbreviations.md](docs_includes%2Fabbreviations.md) file. + +The syntax for abbreviations is: + +```markdown +*[ABBR]: Abbreviation +``` ## CI From 8fc2a2b4d6527f0ab7da6cbb01e126308b14a4ba Mon Sep 17 00:00:00 2001 From: Anes Benmerzoug Date: Fri, 1 Sep 2023 18:22:35 +0200 Subject: [PATCH 5/5] Move changelog entry to 0.7.0's section --- CHANGELOG.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 92f101eec..42a845cf5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,5 @@ # Changelog -## Unreleased - -- Added more abbreviations to documentation - [PR #415](https://github.com/aai-institute/pyDVL/pull/415) - ## 0.7.0 - 📚 Documentation overhaul, new methods and bug fixes 💥 This is our first β release! We have worked hard to deliver improvements across @@ -16,6 +11,8 @@ the board, with a focus on documentation and usability. [PR #365](https://github.com/aai-institute/pyDVL/pull/365) - Enabled parallel computation for Leave-One-Out values [PR #406](https://github.com/aai-institute/pyDVL/pull/406) +- Added more abbreviations to documentation + [PR #415](https://github.com/aai-institute/pyDVL/pull/415) ### Changed - Replaced sphinx with mkdocs for documentation. Major overhaul of documentation