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

Revised Draft ML API. #517

Open
wants to merge 7 commits into
base: ml
Choose a base branch
from
Open
Show file tree
Hide file tree
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
6 changes: 3 additions & 3 deletions meta/subtype-schemas.json
Original file line number Diff line number Diff line change
Expand Up @@ -232,11 +232,11 @@
}
}
},
"ml-model": {
"mlm-model": {
"type": "object",
"subtype": "ml-model",
"title": "Machine Learning Model",
"description": "A machine learning model, accompanied with STAC metadata that implements the the STAC ml-model extension."
"description": "A machine learning model, accompanied with STAC metadata that implements the Machine Learning Model STAC extension (mlm-model)."
},
"output-format": {
"type": "string",
Expand Down Expand Up @@ -426,4 +426,4 @@
"description": "Year as integer, can be any number of digits and can be negative."
}
}
}
}
8 changes: 4 additions & 4 deletions proposals/load_ml_model.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"parameters": [
{
"name": "uri",
"description": "The STAC Item to load the machine learning model from. The STAC Item must implement the `ml-model` extension.",
"description": "The STAC Item to load the machine learning model from. The STAC Item must implement the `mlm-model` extension.",
"schema": [
{
"title": "URL",
Expand All @@ -37,10 +37,10 @@
},
"links": [
{
"href": "https://github.com/stac-extensions/ml-model",
"title": "STAC ml-model extension",
"href": "https://github.com/crim-ca/mlm-extension",
"title": "Machine Learning Model STAC extension",
"type": "text/html",
"rel": "about"
}
]
}
}
16 changes: 5 additions & 11 deletions proposals/ml_fit_class_random_forest.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
"experimental": true,
"parameters": [
{
"name": "predictors",
"description": "The predictors for the classification model as a vector data cube. Aggregated to the features (vectors) of the target input variable.",
"name": "training_set",
"description": "The training set for the Random Forest classification model, provided as a vector data cube. This set contains both the independent variables and dependent variable that the Random Forest algorithm analyses to learn patterns and relationships within the data.",
"schema": [
{
"type": "object",
Expand Down Expand Up @@ -39,15 +39,9 @@
},
{
"name": "target",
"description": "The training sites for the classification model as a vector data cube. This is associated with the target variable for the Random Forest model. The geometry has to associated with a value to predict (e.g. fractional forest canopy cover).",
"description": "The column name in the training set that represents the dependent variable for Random Forest classification.",
"schema": {
"type": "object",
"subtype": "datacube",
"dimensions": [
{
"type": "geometry"
}
]
"type": "string"
}
},
{
Expand Down Expand Up @@ -107,4 +101,4 @@
"rel": "about"
}
]
}
}
18 changes: 6 additions & 12 deletions proposals/ml_fit_regr_random_forest.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
"experimental": true,
"parameters": [
{
"name": "predictors",
"description": "The predictors for the regression model as a vector data cube. Aggregated to the features (vectors) of the target input variable.",
"name": "training_set",
"description": "The training set for the Random Forest regression model, provided as a vector data cube. This set contains both the independent variables and dependent variable that the Random Forest algorithm analyses to learn patterns and relationships within the data.",
"schema": [
{
"type": "object",
Expand Down Expand Up @@ -39,15 +39,9 @@
},
{
"name": "target",
"description": "The training sites for the regression model as a vector data cube. This is associated with the target variable for the Random Forest model. The geometry has to associated with a value to predict (e.g. fractional forest canopy cover).",
"description": "The column name in the training set that represents the dependent variable for Random Forest regression.",
"schema": {
"type": "object",
"subtype": "datacube",
"dimensions": [
{
"type": "geometry"
}
]
"type": "string"
}
},
{
Expand Down Expand Up @@ -96,7 +90,7 @@
"description": "A model object that can be saved with ``save_ml_model()`` and restored with ``load_ml_model()``.",
"schema": {
"type": "object",
"subtype": "ml-model"
"subtype": "mlm-model"
}
},
"links": [
Expand All @@ -107,4 +101,4 @@
"rel": "about"
}
]
}
}
4 changes: 2 additions & 2 deletions proposals/ml_predict.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"description": "A ML model that was trained with one of the ML training processes such as ``ml_fit_regr_random_forest()``.",
"schema": {
"type": "object",
"subtype": "ml-model"
"subtype": "mlm-model"
}
},
{
Expand All @@ -46,4 +46,4 @@
]
}
}
}
}
8 changes: 4 additions & 4 deletions proposals/save_ml_model.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "save_ml_model",
"summary": "Save a ML model",
"description": "Saves a machine learning model as part of a batch job.\n\nThe model will be accompanied by a separate STAC Item that implements the [ml-model extension](https://github.com/stac-extensions/ml-model).",
"description": "Saves a machine learning model as part of a batch job.\n\nThe model will be accompanied by a separate STAC Item that implements the [mlm-model extension](https://github.com/crim-ca/mlm-extension).",
"categories": [
"machine learning",
"import"
Expand All @@ -13,7 +13,7 @@
"description": "The data to store as a machine learning model.",
"schema": {
"type": "object",
"subtype": "ml-model"
"subtype": "mlm-model"
}
},
{
Expand All @@ -35,8 +35,8 @@
},
"links": [
{
"href": "https://github.com/stac-extensions/ml-model",
"title": "STAC ml-model extension",
"href": "https://github.com/crim-ca/mlm-extension",
"title": "Machine Learning Model STAC extension",
"type": "text/html",
"rel": "about"
}
Expand Down
1 change: 1 addition & 0 deletions tests/.words
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,4 @@ Hyndman
date1
date2
favor
mlm-model
Loading