Docs: fix example; export MinPrecisionThreshold

This commit is contained in:
2020-05-05 13:12:30 -05:00
parent abbd2d2207
commit a803d73a3b
6 changed files with 5 additions and 4 deletions

View File

@@ -197,7 +197,7 @@ while raising a component's threshold makes it more conservative. </p>
to achieve a minimum desired true positive rate (also known as precision). The example below shows how to initialize to achieve a minimum desired true positive rate (also known as precision). The example below shows how to initialize
a <code>PrimalSolutionComponent</code> which achieves 95% precision, possibly at the cost of a lower recall. To make the component a <code>PrimalSolutionComponent</code> which achieves 95% precision, possibly at the cost of a lower recall. To make the component
more aggressive, this precision may be lowered.</p> more aggressive, this precision may be lowered.</p>
<pre><code class="python">comp = PrimalSolutionComponent(threshold=MinPrecisionThreshold(0.98)) <pre><code class="python">PrimalSolutionComponent(threshold=MinPrecisionThreshold(0.95))
</code></pre></div> </code></pre></div>

View File

@@ -273,5 +273,5 @@
<!-- <!--
MkDocs version : 1.1 MkDocs version : 1.1
Build Date UTC : 2020-05-05 18:08:32 Build Date UTC : 2020-05-05 18:12:23
--> -->

File diff suppressed because one or more lines are too long

Binary file not shown.

View File

@@ -59,5 +59,5 @@ a `PrimalSolutionComponent` which achieves 95% precision, possibly at the cost o
more aggressive, this precision may be lowered. more aggressive, this precision may be lowered.
```python ```python
comp = PrimalSolutionComponent(threshold=MinPrecisionThreshold(0.98)) PrimalSolutionComponent(threshold=MinPrecisionThreshold(0.95))
``` ```

View File

@@ -14,6 +14,7 @@ from .components.primal import PrimalSolutionComponent
from .components.branching import BranchPriorityComponent, BranchPriorityExtractor from .components.branching import BranchPriorityComponent, BranchPriorityExtractor
from .classifiers.adaptive import AdaptiveClassifier from .classifiers.adaptive import AdaptiveClassifier
from .classifiers.threshold import MinPrecisionThreshold
from .benchmark import BenchmarkRunner from .benchmark import BenchmarkRunner