kevinconka commited on
Commit
a195341
Β·
verified Β·
1 Parent(s): 2571dcc

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +27 -26
README.md CHANGED
@@ -17,25 +17,40 @@ pinned: false
17
  </div>
18
 
19
  <div align="center">
20
- <h2> Want to contribute? </h2>
21
  </div>
22
 
23
  - πŸ₯™ For naming models, spaces, datasets, and metrics, employ [kebab-case](https://en.wiktionary.org/wiki/kebab_case). Use lowercase letters, except for acronyms, which may be capitalized.
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
  - Output should look like this:
37
- ```json
38
- {
39
  "ahoy_IR_b2_engine_3_6_0_49_gd81d3b63_oversea": {
40
  "overall": {
41
  "all": {
@@ -74,21 +89,7 @@ Your metric should have the following structure:
74
  }
75
  }
76
  }
77
- }```
78
-
79
- </details>
80
 
81
- <div align="center">
82
- <h2> Looking for metrics? </h2>
83
- </div>
84
-
85
- - https://huggingface.co/spaces/SEA-AI/det-metrics
86
- - Object detection metrics based on [`pycocotools`](https://github.com/cocodataset/cocoapi) and [torchmetrics' Mean Avergae Precision](https://lightning.ai/docs/torchmetrics/stable/detection/mean_average_precision.html).
87
- - https://huggingface.co/spaces/SEA-AI/box-metrics
88
- - Bounding box statistics, including IOU, BEP (bottom edge proximity), and others.
89
- - https://huggingface.co/spaces/SEA-AI/horizon-metrics
90
- - Comparing horizons in an image w.r.t their midpoint and slope errors
91
- - https://huggingface.co/spaces/SEA-AI/mot-metrics
92
- - Multi-object-tracking metrics using [`py-motmetrics`](https://github.com/cheind/py-motmetrics)
93
- - https://huggingface.co/spaces/SEA-AI/panoptic-quality
94
- - Evaluating panoptic models
 
17
  </div>
18
 
19
  <div align="center">
20
+ <h1> Want to contribute? </h1>
21
  </div>
22
 
23
  - πŸ₯™ For naming models, spaces, datasets, and metrics, employ [kebab-case](https://en.wiktionary.org/wiki/kebab_case). Use lowercase letters, except for acronyms, which may be capitalized.
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
+ <h1> Looking for metrics? </h1>
29
+ </div>
30
+
31
+ - https://huggingface.co/spaces/SEA-AI/det-metrics
32
+ - Object detection metrics based on [`pycocotools`](https://github.com/cocodataset/cocoapi) and [torchmetrics' Mean Avergae Precision](https://lightning.ai/docs/torchmetrics/stable/detection/mean_average_precision.html).
33
+ - https://huggingface.co/spaces/SEA-AI/box-metrics
34
+ - Bounding box statistics, including IOU, BEP (bottom edge proximity), and others.
35
+ - https://huggingface.co/spaces/SEA-AI/horizon-metrics
36
+ - Comparing horizons in an image w.r.t their midpoint and slope errors
37
+ - https://huggingface.co/spaces/SEA-AI/mot-metrics
38
+ - Multi-object-tracking metrics using [`py-motmetrics`](https://github.com/cheind/py-motmetrics)
39
+ - https://huggingface.co/spaces/SEA-AI/panoptic-quality
40
+ - Evaluating panoptic models
41
+
42
  <details>
43
+ <summary>Proposed Metric Output Structure</summary>
44
 
45
  Your metric should have the following structure:
46
+ - `_compute(references, predictions)`
47
+ - Calls a metric engine, defined for example in the `seametrics` package, or other
48
+ - `compute_from_payload(paylaod)`
49
+ - Call the `module.compute` method internally after converting payload -> references, predictions
50
+ - All the metric's parameters, such as `iou_threshold`, `area_ranges`, etc.. should be moved to the `__init__` method.
51
  - Output should look like this:
52
+ ```json
53
+ {
54
  "ahoy_IR_b2_engine_3_6_0_49_gd81d3b63_oversea": {
55
  "overall": {
56
  "all": {
 
89
  }
90
  }
91
  }
92
+ }
93
+ ```
 
94
 
95
+ </details>