Skip to content

Commit 95b0ac8

Browse files
committed
Fix broken references in docs
1 parent 1df839c commit 95b0ac8

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ To add a citation inside a markdown file, use the notation `[@ citekey]` (with
415415
no space). Alas,
416416
because of when mkdocs-bibtex enters the pipeline, it won't process docstrings.
417417
For module documentation, we manually inject html into the markdown files. For
418-
example, in `pydvl.value.shapley.montecarlo` we have:
418+
example, in `pydvl.valuation.methods.shapley` we have:
419419

420420
```markdown
421421
"""

docs/value/shapley.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,14 @@ and others are preferred, but if desired, usage follows the same pattern:
9595
result = valuation.result
9696
```
9797

98-
Note the usage of the object [MaxSamples][pydvl.value.stopping.MaxSamples] as
98+
Note the usage of the object [MaxSamples][pydvl.valuation.stopping.MaxSamples] as
9999
the stopping condition, which takes the sampler as argument. This is a special
100-
instance of a [StoppingCriterion][pydvl.value.stopping.StoppingCriterion]. More
100+
instance of a [StoppingCriterion][pydvl.valuation.stopping.StoppingCriterion]. More
101101
examples which are not tied to the sampler are
102-
[MaxTime][pydvl.value.stopping.MaxTime] (stops after a certain time),
103-
[MinUpdates][pydvl.value.stopping.MinUpdates] (looks at the number of updates
102+
[MaxTime][pydvl.valuation.stopping.MaxTime] (stops after a certain time),
103+
[MinUpdates][pydvl.valuation.stopping.MinUpdates] (looks at the number of updates
104104
to the individual values), and
105-
[AbsoluteStandardError][pydvl.value.stopping.AbsoluteStandardError] (not very
105+
[AbsoluteStandardError][pydvl.valuation.stopping.AbsoluteStandardError] (not very
106106
reliable as a stopping criterion), among others.
107107

108108

@@ -152,7 +152,7 @@ a way to reduce the variance of the estimator.
152152
[ShapleyValuation][pydvl.valuation.methods.shapley.ShapleyValuation] with a
153153
custom sampler, for instance
154154
[VRDSSampler][pydvl.valuation.samplers.stratified.VRDSSampler].
155-
Note the use of the [History][pydvl.value.stopping.History] object, a stopping
155+
Note the use of the [History][pydvl.valuation.stopping.History] object, a stopping
156156
which does not stop, but records the trace of value updates in a rolling
157157
memory. The data can then be used to check for convergence, debugging,
158158
plotting, etc.
@@ -215,9 +215,9 @@ Monte Carlo Shapley** [@ghorbani_data_2019], which is efficient enough to be
215215
useful in applications.
216216

217217
The first is simply a convergence criterion, of which
218-
there are [several to choose from][pydvl.value.stopping]. The second is a
218+
there are [several to choose from][pydvl.valuation.stopping]. The second is a
219219
criterion to truncate the iteration over single permutations.
220-
[RelativeTruncation][pydvl.value.shapley.truncated.RelativeTruncation] chooses
220+
[RelativeTruncation][pydvl.valuation.samplers.truncation.RelativeTruncation] chooses
221221
to stop iterating over samples in a permutation when the marginal utility
222222
becomes too small. The method is available through the class
223223
[TMCShapleyValuation][pydvl.valuation.methods.shapley.TMCShapleyValuation].
@@ -240,8 +240,8 @@ You can see this method in action in
240240
Use of this object follows the same pattern as the previous examples, except
241241
that separate instantiation of the sampler is not necessary anymore. This
242242
has the drawback that we cannot use
243-
[MaxSamples][pydvl.value.stopping.MaxSamples] as stopping criterion anymore
244-
since it requires the sampler. To work around this, use
243+
[MaxSamples][pydvl.valuation.stopping.MaxSamples] as stopping criterion
244+
anymore since it requires the sampler. To work around this, use
245245
[ShapleyValuation][pydvl.valuation.methods.shapley.ShapleyValuation]
246246
directly.
247247

0 commit comments

Comments
 (0)