add suggested structure to orgchart
Browse files
README.md
CHANGED
@@ -24,6 +24,18 @@ pinned: false
|
|
24 |
- π Please mind about making the models, spaces and datasets public or private. Metrics can (and have to) be public.
|
25 |
- π€ Do not expose passwords or tokens, use [secrets](https://huggingface.co/docs/hub/spaces-overview#managing-secrets).
|
26 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
27 |
<div align="center">
|
28 |
<h2> Looking for metrics? </h2>
|
29 |
</div>
|
|
|
24 |
- π Please mind about making the models, spaces and datasets public or private. Metrics can (and have to) be public.
|
25 |
- π€ Do not expose passwords or tokens, use [secrets](https://huggingface.co/docs/hub/spaces-overview#managing-secrets).
|
26 |
|
27 |
+
<details>
|
28 |
+
<summary>Structure. (Click to expand)</summary>
|
29 |
+
|
30 |
+
Your metric should have the following structure:
|
31 |
+
- ```_compute(references, predictions)```
|
32 |
+
- Calls a metric engine, defined for example in the ```seametrics``` package, or other
|
33 |
+
- ```compute_from_payload(paylaod)```
|
34 |
+
- Call the ```module.compute``` method internally after converting payload -> references, predictions
|
35 |
+
- All the metric's parameters, such as iou_threshold, area_ranges, etc.. should be moved to the ```__init__``` method.
|
36 |
+
|
37 |
+
</details>
|
38 |
+
|
39 |
<div align="center">
|
40 |
<h2> Looking for metrics? </h2>
|
41 |
</div>
|