Skip to content

Commit 1fc4a8e

Browse files
committed
Rename processes according to recent discussions from #396
1 parent 6baf737 commit 1fc4a8e

7 files changed

+14
-12
lines changed

CHANGELOG.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1515
- `load_geojson`
1616
- `load_ml_model`
1717
- `load_url`
18-
- `predict_ml_model`
19-
- `predict_ml_model_probabilities`
18+
- `ml_fit_class_random_forest`
19+
- `ml_fit_regr_random_forest`
20+
- `ml_predict`
21+
- `ml_predict_probabilities`
2022
- `save_ml_model`
2123
- `unflatten_dimension`
2224
- `vector_buffer`

proposals/predict_dl_model.json renamed to proposals/dl_predict.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"id": "predict_dl_model",
3-
"summary": "Predict values values using DL",
2+
"id": "dl_predict",
3+
"summary": "Predict classification or regression values using DL",
44
"description": "Applies a machine learning model to a data cube of input features and predicts output values or classes for it. This process can be used as process in ``apply_neighborhood()`` to specify the patch size and overlap.",
55
"categories": [
66
"deep learning",

proposals/load_ml_model.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"id": "load_ml_model",
33
"summary": "Load a ML model",
4-
"description": "Loads a machine learning model from a STAC Item.\n\nSuch a model could be trained and saved as part of a previous batch job with processes such as ``fit_regr_random_forest()`` and ``save_ml_model()``.",
4+
"description": "Loads a machine learning model from a STAC Item.\n\nSuch a model could be trained and saved as part of a previous batch job with processes such as ``ml_fit_regr_random_forest()`` and ``save_ml_model()``.",
55
"categories": [
66
"machine learning",
77
"import"
@@ -29,7 +29,7 @@
2929
}
3030
],
3131
"returns": {
32-
"description": "A machine learning model to be used with machine learning processes such as ``predict_ml_model()`` or ``predict_ml_model_probabilities()``.",
32+
"description": "A machine learning model to be used with machine learning processes such as ``ml_predict()`` or ``ml_predict_probabilities()``.",
3333
"schema": {
3434
"type": "object",
3535
"subtype": "ml-model"

proposals/fit_class_random_forest.json renamed to proposals/ml_fit_class_random_forest.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"id": "fit_class_random_forest",
2+
"id": "ml_fit_class_random_forest",
33
"summary": "Train a random forest classification model",
44
"description": "Executes the fit of a random forest classification based on training data. The process does not include a separate split of the data in test, validation and training data. The Random Forest classification model is based on the approach by Breiman (2001).",
55
"categories": [

proposals/fit_regr_random_forest.json renamed to proposals/ml_fit_regr_random_forest.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"id": "fit_regr_random_forest",
2+
"id": "ml_fit_regr_random_forest",
33
"summary": "Train a random forest regression model",
44
"description": "Executes the fit of a random forest regression based on training data. The process does not include a separate split of the data in test, validation and training data. The Random Forest regression model is based on the approach by Breiman (2001).",
55
"categories": [

proposals/predict_ml_model.json renamed to proposals/ml_predict.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"id": "predict_ml_model",
2+
"id": "ml_predict",
33
"summary": "Predict classification or regression values using ML",
44
"description": "Applies a machine learning model to a data cube of input features and predicts output values or classes for it.",
55
"categories": [
@@ -17,7 +17,7 @@
1717
},
1818
{
1919
"name": "model",
20-
"description": "A ML model that was trained with one of the ML training processes such as ``fit_class_random_forest()``.",
20+
"description": "A ML model that was trained with one of the ML training processes such as ``ml_fit_class_random_forest()``.",
2121
"schema": {
2222
"type": "object",
2323
"subtype": "ml-model"

proposals/predict_ml_model_probabilities.json renamed to proposals/ml_predict_probabilities.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"id": "predict_ml_model_probabilities",
2+
"id": "ml_predict_probabilities",
33
"summary": "Predict class probabilities using ML",
44
"description": "Applies a machine learning model to a data cube of input features and predicts the probabilities of the output classes.",
55
"categories": [
@@ -17,7 +17,7 @@
1717
},
1818
{
1919
"name": "model",
20-
"description": "A ML model that was trained with one of the ML training processes such as ``fit_regr_random_forest()``.",
20+
"description": "A ML model that was trained with one of the ML training processes such as ``ml_fit_regr_random_forest()``.",
2121
"schema": {
2222
"type": "object",
2323
"subtype": "ml-model"

0 commit comments

Comments
 (0)