Train Deep Learning Model
- URL:https://<rasteranalysistools-url>/TrainDeepLearningModel
- Related Resources: Add Image, Aggregate Multidimensional Raster, Build Multidimensional Transpose, Calculate Density, Calculate Distance, Calculate Travel Cost, Classify, Classify Object Using Deep Learning, Classify Pixels Using Deep Learning, Convert Feature to Raster, Convert Raster Function Template, Convert Raster to Feature, Copy Raster, Cost Path as Polyline, Create Image Collection, Create Viewshed, Delete Image, Delete Image Collection, Detect Objects Using Deep Learning, Determine Optimum Travel Cost Network, Determine Travel Cost Paths to Destinations, Determine Travel Cost Path as Polyline, Export Training Data for Deep Learning, Fill, Find Argument Statistics, Flow Accumulation, Flow Direction, Flow Distance, Generate Multidimensional Anomaly, Generate Raster, Generate Trend Raster, Install Deep Learning Model, Interpolate Points, Linear Spectral Unmixing, List Deep Learning Model Info, Nibble, Predict Using Trend Raster, Publish Deep Learning Model, Query Deep Learning Model Info, Segment, Stream Link, Subset Multidimensional Raster, Summarize Raster Within, Train Classifier, Train Deep Learning Model,Uninstall Deep Learning Model, Watershed
- Version Introduced:10.8
Description
The TrainDeepLearningModel task is used to train a deep learning model using the output from the Export Training Data for Deep Learning tool. It generates the deep learning model package (*.dlpk) and adds it to your enterprise portal. Tool also provides an option to write the deep learning model package to a fileshare datastore location.

Request parameters
Parameter | Details |
---|---|
in_folder (Required) | This is the input location for the training sample data. It can be the path of output location on the file share raster data store or a shared file system path. The training sample data folder needs to be the output of Export Training Data For Deep Learning tool, containing images and labels folders, as well as the JSON model definition file written out together by the tool. File share raster store path examples: Examples
|
output_name (Required) | A JSON representing the output trained .dlpk name that will be added to your enterprise portal. If the .dlpk item already exists, the portal item Id can be given to the service tool. The output path of the .dlpk file that is generated will be used to update the existing .dlpk item. The output .dlpk file is stored and shared on the hosting server and uploaded to your portal. Examples
|
model_type (Required) | The model type to use for training the deep learning model. The single shot detector (SSD) model type is used for object detection. U-Net (UNET) model types are used to pixel classification. For object classification, the Feature Classifier (FEATURE_CLASSIFIER) model type should be used. The Pyramid Scene Parsing Network (PSPNET) model type is used for pixel classification. Both RetinaNet (RETINANET) and MarkRCNN (MARKRCNN) model types are used for object detection. Values: SSD | UNET | FEATURE_CLASSIFIER | PSPNET | RETINANET | MASKRCNN |
arguments (Optional) | The name of the value pairs of arguments and their values that can be customized by the clients. Example
|
batch_size (Optional) | The number of training samples to be processed for training at one time. If the server has a powerful GPU, this number can be increased to 16, 36, 64, and so on. Example
|
max_epochs (Optional) | The maximum number of epochs for training the model. One epoch means the whole training dataset will be passed forward and backward through the deep neural network once. Example
|
learning_rate (Optional) | The rate at which the weights are updated during the training. It is a small positive value in the range between 0.0 and 1.0. If the learning rate is set to 0, it will extract the optimal learning rate from the learning curve during the training process. Example
|
backbone_model (Optional) | Specifies the preconfigured neural network to be used as an architecture for training the new model. Values: DENSENET121 | DENSENET161 | DENSENET169 | DENSENET201 | MOBILENET_V2 | MASKRCNN50_FPN | RESNET18 | RESNET34 | RESNET50 | RESNET101 | RESNET152 | VGG11 | VGG11_BN | VGG13 | VGG13_BN | VGG16 | VGG16_BN | VGG19 | VGG19_BN Example
|
validation_percent (Optional) | The percentage of training sample data that will be used for validating the model. Example
|
pretrained_model (Optional) | The pretrained model to be used for fine tuning the new model. It is a .dlpk portal item. Example
|
stop_training (Optional) | Specifies whether early stopping will be implemented. If true, the model training will stop when the model is no longer improving, regardless of the maximum epochs specified. This is the default. If false, the model training will continue until the maximum epochs is reached. Values: true | false |
context (Optional) | Environment settings that affect task execution. This task has the following settings:
Example
|
freeze_Model | Specify whether to freeze the backbone layers in the pretrained model, so that the weights and biases in the backbone layers remain unchanged. If true, the predefined weights and biases will not be altered in the backboneModel. This is the default. If false, the weights and biases of the backboneModel may be altered to better fir your training samples. This may take more time to process but usually could get better results. Values: true | false |
f | The response format. The default response format is html. Values: html | json | pjson |
Bokebone model values
Below are the accepted preconfigured neural network values that can be submitted with the backbone_model parameter:
Value | Description |
---|---|
DENSENET121 | The preconfigured model will be a dense network trained on the ImageNET Dataset that contains more than a million images and is 121 layers deep. Unlike RESNET, which combines the layer using summation, DenseNet combines the layers using concatenation. |
DENSENET161 | The preconfigured model will be a dense network trained on the ImageNET Dataset that contains more than a million images and is 161 layers deep. Unlike RESNET, which combines the layer using summation, DenseNet combines the layers using concatenation. |
DENSENET169 | The preconfigured model will be a dense network trained on the ImageNET Dataset that contains more than a million images and is 169 layers deep. Unlike RESNET, which combines the layer using summation, DenseNet combines the layers using concatenation. |
DENSENET201 | The preconfigured model will be a dense network trained on the ImageNET Dataset that contains more than a million images and is 201 layers deep. Unlike RESNET, which combines the layer using summation, DenseNet combines the layers using concatenation. |
MOBILENET_V2 | This preconfigured model is trained on the ImageNet Database and is 54 layers deep geared towards Edge device computing, since it uses less memory. |
MASKRCNN50_FPN | This preconfigured model was trained for object detection with backbone RESNET50 with Feature Pyramid Networks to detect objects at different scales. |
RESNET18 | The preconfigured model will be a residual network trained on the ImageNET Dataset that contains more than a million images and is 18 layers deep. |
RESNET34 | The preconfigured model will be a residual network trained on the ImageNET Dataset that contains more than a million images and is 34 layers deep. This is the default. |
RESNET50 | The preconfigured model will be a residual network trained on the ImageNET Dataset that contains more than a million images and is 50 layers deep. |
RESNET101 | The preconfigured model will be a residual network trained on the ImageNET Dataset that contains more than a million images and is 101 layers deep. |
RESNET152 | The preconfigured model will be a residual network trained on the ImageNET Dataset that contains more than a million images and is 152 layers deep. |
VGG11 | The preconfigured model will be a convolution neural network trained on the ImageNET Dataset that contains more than a million images to classify images into 1000 object categories and is 11 layers deep. |
VGG11_BN | This preconfigured model is based on the VGG network but with batch normalization, which is each layer in the network in normalized. It trained on the ImageNet dataset and has 11 layers. |
VGG13 | The preconfigured model will be a convolution neural network trained on the ImageNET Dataset that contains more than a million images to classify images into 1000 object categories and is 13 layers deep. |
VGG13_BN | This preconfigured model is based on the VGG network but with batch normalization, which is each layer in the network in normalized. It trained on the ImageNet dataset and has 13 layers. |
VGG16 | The preconfigured model will be a convolution neural network trained on the ImageNET Dataset that contains more than a million images to classify images into 1000 object categories and is 16 layers deep. |
VGG16_BN | This preconfigured model is based on the VGG network but with batch normalization, which is each layer in the network in normalized. It trained on the ImageNet dataset and has 16 layers. |
VGG19 | The preconfigured model will be a convolution neural network trained on the ImageNET Dataset that contains more than a million images to classify images into 1000 object categories and is 19 layers deep. |
VGG19_BN | This preconfigured model is based on the VGG network but with batch normalization, which is each layer in the network in normalized. It trained on the ImageNet dataset and has 19 layers. |
Example usage
The following is a sample request URL for TrainDeepLearningModel:
https://services.myserver.com/arcgis/rest/services/System/RasterAnalysisTools/GPServer/TrainDeepLearningModel
Response
When you submit a request, the task assigns a unique job ID for the transaction.
Syntax:
{ "jobId": "<unique job identifier>", "jobStatus": "<job status>" }
After the initial request is submitted, you can use the jobId to periodically check the status of the job and messages as described in Checking job status. Once the job has successfully completed, use the jobId to retrieve the results. To track the status, you can make a request of the following form:
https://<rasterAnalysisTools-url>/TrainDeepLearningModel/jobs/<jobId>
When the status of the job request is esriJobSucceeded, you can access the results of the analysis by making a request of the following form:
https://<rasterAnalysisTools-url>/TrainDeepLearningModel/jobs/<jobId>/results/outObjects
JSON Response example
The response returns the .dlpk portal item, which has properties for title, type, filename, file, id, and folderId.
{
"title": "dlpk_name",
"type": "Deep Learning Package",
"multipart": True,
"tags": "imagery"
"typeKeywords": "Deep Learning, Raster"
"filename": "dlpk_name",
"file": "\\servername\rasterstore\mytrainedmodel.dlpk",
"id": "f121390b85ef419790479fc75b493efd",
"folderId": "dfwerfbd3ec25584d0d8f4"
}
However, if a datastore path is specified as the value for outputName, the output would be the datastore location.
{
"paramName": "out_item",
"dataType": "GPString",
"value": {
"model": "/fileShares/filesharename /folder"
}
}