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

Documented input artifact format #212

Merged
merged 1 commit into from
Aug 18, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/artifact-format.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Preparing Artifact format

When saving an artifact with ORMB you have to declare its format in ormbfile.yaml, which is case sensitive. Here is the list of the accepted format values and extensions.

| Format | Required format value | Required artifact extension |
| ------------- | ------------- | ------------- |
| SavedModel | "SavedModel" | "saved_model.pb" |
| ONNX | "ONNX" | ".onnx" |
| H5 | "H5" | ".h5" |
| PMML | "PMML" | ".pmml" |
| CaffeModel | "CaffeModel" | ".caffemodel" |
| NetDef | "NetDef" | "init_net.pb" |
| MXNetParams | "MXNetParams" | ".params" |
| TorchScript | "TorchScript" | ".pt" |
| GraphDef | "GraphDef" | ".graphdef" |
| TensorRT | "TensorRT" | ".engine" |
| SKLearn | "SKLearn" | ".joblib" |
| XGBoost | "XGBoost" | ".xgboost" |
| MLflow | "MLflow" | - |
| Pickle | "Pickle" | ".pickle" |
| Others | "Others" | - |