Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix typo #111

Merged
merged 2 commits into from
Nov 7, 2018
Merged

fix typo #111

merged 2 commits into from
Nov 7, 2018

Conversation

frank-wei
Copy link

Model Name

Use-cases

Model use cases

Description

Description of model

Model

Model Download Checksum Download (with sample test data) ONNX version Opset version Accuracy
Model Name ONNX Model download link with size MD5 checksum for the ONNX model tar file containing ONNX model and synthetic test data (in .pb format) ONNX version used for conversion Opset version used for conversion Accuracy values

All ONNX models must pass the ONNX model checker before contribution. The snippet of code below can be used to perform the check. If any errors are encountered, it implies the check has failed.

import onnx
from onnx import checker
model_proto = onnx.load("path to .onnx file")
checker.check_model(model_proto)

Inference

Step by step instructions on how to use the pretrained model and link to an example notebook/code. This section should ideally contain:

Input to model

Input to network (Example: 224x224 pixels in RGB)

Preprocessing steps

Preprocessing required

Output of model

Output of network

Postprocessing steps

Post processing and meaning of output


Dataset (Train and validation)

This section should discuss datasets and any preparation steps if required.


Validation accuracy

Details of experiments leading to accuracy and comparison with the reference paper.


Training

Training details (preprocessing, hyperparameters, resources and environment) along with link to a training notebook (optional).

Also clarify in case the model is not trained from scratch and include the source/process used to obtain the ONNX model.


Validation

Validation script/notebook used to obtain accuracy reported above along with details of how to use it and reproduce accuracy.


References

Link to references


Contributors

Contributors' name


License

Add license information


@CLAassistant
Copy link

CLAassistant commented Nov 7, 2018

CLA assistant check
All committers have signed the CLA.

@prasanthpul prasanthpul merged commit 4923077 into onnx:master Nov 7, 2018
@prasanthpul
Copy link
Member

Thanks!

jcwchen pushed a commit to jcwchen/models that referenced this pull request Apr 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants