Skip to content
This repository has been archived by the owner on Feb 16, 2022. It is now read-only.

Commit

Permalink
Adds JSON template (#44)
Browse files Browse the repository at this point in the history
* Add catalog template

* Add note in README
  • Loading branch information
Jon Duckworth authored Sep 9, 2021
1 parent fa0b20d commit cfbf9db
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ The Geospatial ML Model Catalog (GMLMC) specification takes advantage of the STA
associated with a model, and we hope that discussions relating to the GMLMC spec will help guide development of those
standards as well.

## Examples

Example are currently a work in progress and we hope to have some soon. There is a [template
file](./examples/template.json) that demonstrates the overall structure and types in the JSON document.

## Stability & Versioning

This specification is a work in progress and should be considered unstable until further notice. The specification
Expand Down
85 changes: 85 additions & 0 deletions examples/template.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
{
"version": "0.1.0",
"model_id": "template",
"model_type": {
"learning_approach": "Supervised",
"prediction_type": "Classification",
"architecture": "RCNN",
"description": "Description here"
},
"license": "MIT",
"contacts": [
{
"name": "Some Person",
"organization": "My Organization",
"email": "[email protected]"
}
],
"citation": {
"doi": "10.1000/xyz123",
"citation": "RECOMMENDED CITATION HERE",
"publications": [
{
"doi": "10.1111/xyz123",
"citation": "PUBLICATION CITATION HERE"
}
]
},
"training": {
"created_at": "2020-04-12T23:20:50.52Z",
"environment": {
"processor": {
"number_of_cores": 8,
"processor_type": "GPU"
},
"operating_system": "Windows",
"programming_language": "Python",
"dependencies": "https://www.github.com/myorg/myrepo/blob/main/somefolder/requirements.txt"
},
"data": [
"https://api.radiant.earth/mlhub/v1/collections/ref_african_crops_kenya_01_source"
]
},
"inputs": [
{
"name": "input_var_1",
"type": "float32",
"shape": [50, 256, 256],
"description": "Description of what the inputs should look like"
}
],
"outputs": [
{
"name": "output_var_2",
"type": "float32",
"shape": [50, 1],
"description": "Description of what the outputs of the model are"
}
],
"runtimes": [
{
"type": "docker",
"properties": {
"format": "Docker",
"link": "myregistryhost:5000/organization/model_container:1.0.0",
"code_examples": [
"https://www.github.com/myorganization/greatexamples"
],
"host_requirements": "???"
}
}
],
"usage_recommendations": {
"recommendations": [
{
"spatial": [
[34.18, 0.47 ,34.37, 0.71]
],
"temporal": [
["2018-04-12T00:00:00Z", "2020-03-12T00:00:00Z"]
],
"description": "Description of usage recomendation"
}
]
}
}

0 comments on commit cfbf9db

Please sign in to comment.