Skip to content

Commit

Permalink
doc(sampler): typo
Browse files Browse the repository at this point in the history
  • Loading branch information
breakthewall committed Mar 7, 2024
1 parent 47897e2 commit a506c21
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions icfree/sampler/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ The number of values generated is given by the user and the values are saved in

It is important to note that the user can pass some values that he whishes to combine. In this case, we are dealing with discrete space, and because LHS is working on continuous space the result sampling can contain duplicates. To avoid this, we have set some filters to select the appropriate sampling method. Let consider $N$ the number of possible combinations and $n$ the number of samples to generate. The following rules are applied:
<ul>
<li>If $n < \frac{N}{3}$ or if the CLI option <code>--method</code> is set to <code>`lhs`</code>, then LHS is applied. If the result sampling contain duplicates, then we replace them by random samples.</li>
<li>If $n > \frac{N}{3}$ or if the CLI option <code>`--method`</code> is set to <code>`random`</code>, then LHS is not required and we proceed to random sampling.</li>
<li>If $n \leq \frac{N}{3}$ or if the CLI option <code>--method</code> is set to <code>`lhs`</code>, then LHS is applied. If the result sampling contain duplicates, then we replace them by random samples.</li>
<li>If $n \gt \frac{N}{3}$ or if the CLI option <code>`--method`</code> is set to <code>`random`</code>, then LHS is not required and we proceed to random sampling.</li>
<li>If $n = N$ or if the CLI option <code>`--method`</code> is set to <code>`all`</code>, then we generate all the combinations.</li>
</ul>

Expand Down

0 comments on commit a506c21

Please sign in to comment.