Skip to content

Commit 2565aef

Browse files
committed
Re-render readme
1 parent 7920a95 commit 2565aef

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,15 @@ Metrics As Scores
2424
class="toc-section-number">1.3.3</span> Running Tests</a>
2525
- <a href="#example-usage" id="toc-example-usage"><span
2626
class="toc-section-number">2</span> Example Usage</a>
27+
- <a href="#concrete-example-using-the-iris-dataset"
28+
id="toc-concrete-example-using-the-iris-dataset"><span
29+
class="toc-section-number">2.1</span> Concrete Example Using the Iris
30+
Dataset</a>
2731
- <a href="#software-metrics-example"
2832
id="toc-software-metrics-example"><span
29-
class="toc-section-number">2.1</span> Software Metrics Example</a>
33+
class="toc-section-number">2.2</span> Software Metrics Example</a>
3034
- <a href="#diamonds-example" id="toc-diamonds-example"><span
31-
class="toc-section-number">2.2</span> Diamonds Example</a>
35+
class="toc-section-number">2.3</span> Diamonds Example</a>
3236
- <a href="#datasets" id="toc-datasets"><span
3337
class="toc-section-number">3</span> Datasets</a>
3438
- <a href="#use-your-own" id="toc-use-your-own"><span
@@ -48,7 +52,7 @@ between versions
4852
[**`v1.0.8`**](https://github.com/MrShoenel/metrics-as-scores/tree/v1.0.8)
4953
and **`v2.x.x`**.
5054

51-
The current version is `v2.3.3`.
55+
The current version is `v2.4.0`.
5256

5357
From version **`v2.x.x`** it has the following new features:
5458

@@ -222,6 +226,14 @@ what might constitute a common/ideal value, and how distant the sample
222226
is from that value. This is expressed in terms of a percentile (a
223227
standardized scale of `[0,1]`), which we call **score**.
224228

229+
## Concrete Example Using the Iris Dataset
230+
231+
The notebook
232+
[`notebooks/Example-create-own-dataset.ipynb`](https://github.com/MrShoenel/metrics-as-scores/blob/master/notebooks/Example-create-own-dataset.ipynb)
233+
holds a concrete example for creating/importing/using one’s own dataset.
234+
Although all necessary steps can be achieved using the **TUI**, this
235+
notebook demonstrates a complete example of implementing this in code.
236+
225237
## Software Metrics Example
226238

227239
Software metrics, when captured out of context, are meaningless (Gil and

0 commit comments

Comments
 (0)