模型卡模板

对于一个公有的 HubAI 模型, 模型卡(Model Card) 的结构应该如下:

Code

1# Model Details
2
3## Model Description
4
5TODO
6
7- **Developed by:**: TODO
8- **Shared by:** TODO
9- **Model type:** TODO
10- **License:** TODO
11- **Resources for more information:**
12    - TODO
13
14# Training Details
15
16## Training Data
17
18TODO
19
20# Testing Details
21
22## Metrics
23
24TODO
25
26# Technical Specifications
27
28## Input/Output Details
29
30- **Input**:
31    - Name: TODO
32    - Info: TODO
33- **Output**:
34    - Name: TODO
35    - Info: TODO
36
37## Model Architecture
38
39TODO
40
41## Throughput
42
43### Model variant: TODO
44• **Input shape**: TODO • **Output shape**: TODO
45• **Params (M)**: TODO • **GFLOPs**: TODO
46| Platform | Precision | Throughput (infs/sec) | Power Consumption (W) |
47|----------|-----------|-----------------------|-----------------------|
48| RVC2     | TODO      | TODO                  | TODO                  |
49| RVC3     | TODO      | TODO                  | TODO                  |
50| RVC4     | TODO      | TODO                  | TODO                  |
51
52### Model variant: TODO
53...
54
55\* Benchmarked with [DAIv3](https://docs.luxonis.com/software-v3/depthai/), using 2 threads (and the DSP runtime in balanced mode for RVC4).
56\* Parameters and FLOPs are obtained from the [onnx-tool](https://github.com/ThanatosShinji/onnx-tool) package.
57
58## Quantization
59
60TODO
61
62# Utilization
63
64TODO
65
66## Example
67<link to minimal working example>

附加指南

有些模型具有非常具体的后处理步骤, 需要采取这些步骤才能获得有意义的输出. 我们建议您在 Utilization 板块下拓展该部分内容以便其他社区成员也可以使用他们. 最好是代码段落和附加注释的组合.如果您已有一个工作示例, 您可以随时通过Github gist, 存储库或类似内容将其作为链接共享. 这应该是一个显示通过DepthAI管道将数据传递到模型中, 解析原始输出以及可选的、一些基础可视化(如果有关)的最小的工作示例.我们已经有一些现有的解析器, 您可以在 depthai-nodes 库中用于此目的. 如果他们都不适用, 并且您创建了一个新的解析节点, 请向存储库发出拉取请求并帮助开发.重要: 为了让您的示例的使用尽可能简单, 我们强烈建议您声明您在测试期间使用的DepthAI版本(depthai-nodes 版本). 这样其他人就可以轻松复制您的环境.

ON THIS PAGE

模型卡模板

附加指南